# SPB

## XFEL

[add component documentation]

### SDIAG

[add component documentation]

#### BAM

[add component documentation]

##### DOOCS

[add component documentation]

###### 1932M_TL

DoocsBunchArrivalMonitors Documentation

The `DoocsBunchArrivalMonitors` device is documented in doocsdevices:buncharrivalmonitors

###### 1932S_TL

DoocsBunchArrivalMonitors Documentation

The `DoocsBunchArrivalMonitors` device is documented in doocsdevices:buncharrivalmonitors

###### 414_B2

DoocsBunchArrivalMonitors Documentation

The `DoocsBunchArrivalMonitors` device is documented in doocsdevices:buncharrivalmonitors

## ACC

[add component documentation]

### SYS

[add component documentation]

#### DOOCS

[add component documentation]

##### CTRL

[add component documentation]

###### BEAMCONDITIONS

Instance id: | ACC_SYS_DOOCS/CTRL/BEAMCONDITIONS
Class id: | DoocsBeamConditions
Host: | spb-rr-sys-con-06
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/doocsDevices
Last modified: | 2021-06-15T11:00:23.000+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Hauf, Parenti
Latest tag: | 1.8.14-2.11.1
Deployment tag: | 1.8.14-2.11.1
Installed tag: | 1.8.12-2.10.4
Projects: | DOOCS, MAIN_copy
Scenes: | imgProc, im_Proc_1, correlator, imgProc, correlator, Beam_Conditions, SA1_Beam_Conditions
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.8.12-2.10.4) does not match tags mentioned in the deployment ([‘1.8.14-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
- locationEnergy:
    Location identifies DOOCS server like FACILITY/DEVICE/LOCATION
- locationKParameter:
    Location identifies DOOCS server like FACILITY/DEVICE/LOCATION
- energy:
    Identifies DOOCS property ENERGY.SA1 on DOOCS server with location given in ‘locationEnergy’
- kParameter:
    Identifies DOOCS property K (K parameter) on DOOCS server with location given in ‘locationKParameter’
- updateInterval:
    The interval for updating DOOCS for read-out values.

Release History
1.8.14-2.11.1

Created: | 2021-06-08T13:36:50.000Z
Author: | Gabriele Giovanetti
Notes: | fix DEPENDS

1.8.13-2.11.1

Created: | 2021-05-19T12:26:44.000Z
Author: | Steffen Hauf
Notes: | Merge branch ‘feat/mirror_scene’ into ‘master’

1.8.12-2.10.4

Created: | 2021-05-05T10:20:05.000Z
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-21T14:09:17.000Z
Author: | Alessandro Silenzi
Notes: | FIX: cast delay to integer to comply with Karabo 2.11

1.8.10-2.10.2

Created: | 2021-02-10T14:47:03.000Z
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-12T12:38:56.000Z
Author: | Andrea Parenti
Notes: | Summary: * FEATURE inject runtime properties; * FIX initialization of DoocsOpticalDelay.

1.8.8-2.10.0

Created: | 2020-11-24T07:05:35.000Z
Author: | Steffen Hauf
Notes: |

1.8.7-2.9.4

Created: | 2020-11-12T15:46:42.000Z
Author: | Riccardo Fabbri
Notes: | Authorization to write to DOOCS retrieved at property level

1.8.6-2.9.4-fxe-xgmd

Created: | 2020-10-09T14:11:02.000Z
Author: | ehsanw
Notes: | to be used for fxe-xgmd

1.8.6-2.9.4

Created: | 2020-10-07T05:37:53.000Z
Author: | Steffen Hauf
Notes: | Add laser steering to bunch pattern pulser

1.8.5-2.9.1-xgm-log-timestamps

Created: | 2020-09-24T18:09:47.000Z
Author: | ehsanw
Notes: | Added timestamp and train id logging for xgm

1.8.5-2.9.1

Created: | 2020-09-15T07:18:47.000Z
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-02T07:35:59.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Description field added to the table.

1.8.3-2.9.1

Created: | 2020-08-26T10:18:01.000Z
Author: | Wajid Ehsan
Notes: | Bunch Arrival Monitor new parameters

1.8.2-2.9.1

Created: | 2020-08-26T09:20:59.000Z
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-21T11:49:45.000Z
Author: | Steffen Hauf
Notes: | Updates for the bunch pattern pulse

1.8.0-2.9.1-sqs-pattern-delay

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

1.8.0-2.9.1

Created: | 2020-08-07T15:10:21.000Z
Author: | Steffen Hauf
Notes: | Add the DoocsMirror device

1.7.0-2.9.1

Created: | 2020-08-05T09:24:35.000Z
Author: | Steffen Hauf
Notes: | Add BunchPatternPulser Device

1.6.7-2.9.1

Created: | 2020-08-04T16:57:39.000Z
Author: | mamchykd
Notes: | Updates for DoocsUndulatorCells device (fix for a proper xml structure and calculation of lastClosedUndulator property value). The tag is ok for deployment

## LA1

[add component documentation]

### LAS

[add component documentation]

#### PPL

[add component documentation]

##### ACTRL

[add component documentation]

###### AO_SIGNAL_BOX_CH1

Instance id: | LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH1
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

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

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

###### AO_SIGNAL_BOX_CH2

Instance id: | LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH2
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

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

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

###### AO_SIGNAL_BOX_CH3

Instance id: | LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH3
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

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

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

###### AO_SIGNAL_BOX_CH4

Instance id: | LA1_LAS_PPL/ACTRL/AO_SIGNAL_BOX_CH4
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

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

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

###### GUIDELASER_FXE_MOD_IN

Instance id: | LA1_LAS_PPL/ACTRL/GUIDELASER_FXE_MOD_IN
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

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

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

###### GUIDELASER_SPB_MOD_IN

Instance id: | LA1_LAS_PPL/ACTRL/GUIDELASER_SPB_MOD_IN
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

BeckhoffAnalogOutput Documentation

The `BeckhoffAnalogOutput` device is documented in beckhoff:BeckhoffAnalogOutput

Device Schema Description

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

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

##### ADC

[add component documentation]

###### 1

Instance id: | LA1_LAS_PPL/ADC/1
Class id: | FastAdc
Host: | spb-rr-sys-con-camopt
Class documentation:
| FastAdc
Alias: | spb-rr-sys-con-camopt
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/fastAdc
Last modified: | 2021-07-01T18:38:03.000+02:00
Created at: | 2016-12-22T15:17:58.000+01:00
Main authors: | Fernandes, Ehsan, Ehsanw
Latest tag: | 2.8.3-2.11.1
Deployment tag: | 2.8.3-2.11.1
Scenes: | PPL_BCCs
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Installation not found in a standard path!

Fast ADC

The `FastADC` device is documented in fastadc:welcome

Trouble Shooting

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

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

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

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- digitizerFrequency:
    ADC sampling frequency.
- adcRange:
    Voltage range (peak to peak) of ADC chips.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Time delay between trigger and start of raw data acquisition.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- timeAxis:
    Time of sample (relative to trigger signal).
- rawDataMode:
    Determines the conditions under which raw data is acquired. If ‘conditional’, only acquire raw data when the train has bunches for the current Bunch Pattern decoder configuration.
- rawDynamic:
    When true, raw acquisition starts at the first bunch for the current Bunch Pattern decoder configuration.
- triggerTime:
    Time between Triggers
- trainId:
    Current train ID as read from the FPGA
- timingSync:
    Timing Sync status as read from The FPGA. When true, FastADC is synchronized with MicroTCA Timing System
- sampleFirstBunch:
    Sample number of the first bunch
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- bunchPatternNode:
    Set up bunch pattern decoding parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters

Release History
2.8.3-2.11.1

Created: | 2021-06-25T11:42:45.000Z
Author: | Gabriele Giovanetti
Notes: | FIX: timeAxis maxSize that was wrong, and breaking middlelayers

2.8.2-2.11.1

Created: | 2021-06-15T17:42:44.000Z
Author: | Wajid Ehsan
Notes: | Fix bunch period issue

2.8.1-2.11.1

Created: | 2021-06-15T16:00:03.000Z
Author: | Wajid Ehsan
Notes: | Update depends tag

2.8.0-2.11.1

Created: | 2021-06-11T14:21:15.000Z
Author: | Bruno Fernandes
Notes: | FastADC firmware 3.5.21

2.7.8-2.11.1

Created: | 2021-06-09T09:37:55.000Z
Author: | Wajid Ehsan
Notes: | update tag for iibus

2.7.7-2.11.1

Created: | 2021-06-02T16:15:10.000Z
Author: | Wajid Ehsan
Notes: | Fix indentation issues

2.7.6-2.10.0

Created: | 2021-06-02T07:25:59.000Z
Author: | Bruno Fernandes
Notes: | Raw and peak data in Voltage levels

2.7.6-2.10.0-only_for_laslab

Created: | 2021-02-04T13:52:10.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Karabo 2.10 Versioning Info added to LASLAB branch (new features)

2.7.5-2.10.0

Created: | 2020-11-26T11:52:36.000Z
Author: | Steffen Hauf
Notes: | Swapped TCLKA and TCLKB values.

2.7.4-2.10.0

Created: | 2020-11-24T13:31:13.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

2.7.3-2.9.1

Created: | 2020-09-23T15:43:01.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Bug/Fix: Replace fixedBaselineEna with useDynamicBaseline

2.7.2-2.9.0

Created: | 2020-09-11T14:25:10.000Z
Author: | Wajid Ehsan
Notes: | Remove deprecated slots

2.7.1-2.9.0

Created: | 2020-09-10T08:12:17.000Z
Author: | Robert Schaffer
Notes: | For Firmware version 3.5

2.7.0-2.9.0

Created: | 2020-09-09T17:36:37.000Z
Author: | Robert Schaffer
Notes: |

2.6.4-2.6.1-only_for_laslab

Created: | 2019-11-26T12:38:00.000Z
Author: | Riccardo Fabbri
Notes: | Train statistics included in special branch dedicated to laslab.

2.6.3-2.6.1

Created: | 2019-11-12T12:27:17.000Z
Author: | Denys Mamchyk
Notes: | fix for “Raw Delay” and “Pulse Delay” max limits

2.6.2-2.5.0

Created: | 2019-07-11T07:56:32.000Z
Author: | Riccardo Fabbri
Notes: | BugFix: wipeRawPipelineData: Nr of channels in loop corrected

2.6.1-2.4.0

Created: | 2019-06-20T11:01:02.000Z
Author: | Steffen Hauf
Notes: |

2.6.0-2.4.0

Created: | 2019-06-03T10:58:20.000Z
Author: | Steffen Hauf
Notes: | Add the fasterADC device, which only outputs raw data

2.5.0-2.4.0

Created: | 2019-05-02T15:15:13.000Z
Author: | Alessandro Silenzi
Notes: | FIX: avoid sending old data if RAW not ready Documentation

###### 2

Instance id: | LA1_LAS_PPL/ADC/2
Class id: | FastAdc
Host: | spb-rr-sys-con-camopt
Class documentation:
| FastAdc
Alias: | spb-rr-sys-con-camopt
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/fastAdc
Last modified: | 2021-07-01T18:38:03.000+02:00
Created at: | 2016-12-22T15:17:58.000+01:00
Main authors: | Fernandes, Ehsan, Ehsanw
Latest tag: | 2.8.3-2.11.1
Deployment tag: | 2.8.3-2.11.1
Scenes: | PPL_BCCs
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Installation not found in a standard path!

Fast ADC

The `FastADC` device is documented in fastadc:welcome

Trouble Shooting

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

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

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

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- digitizerFrequency:
    ADC sampling frequency.
- adcRange:
    Voltage range (peak to peak) of ADC chips.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Time delay between trigger and start of raw data acquisition.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- timeAxis:
    Time of sample (relative to trigger signal).
- rawDataMode:
    Determines the conditions under which raw data is acquired. If ‘conditional’, only acquire raw data when the train has bunches for the current Bunch Pattern decoder configuration.
- rawDynamic:
    When true, raw acquisition starts at the first bunch for the current Bunch Pattern decoder configuration.
- triggerTime:
    Time between Triggers
- trainId:
    Current train ID as read from the FPGA
- timingSync:
    Timing Sync status as read from The FPGA. When true, FastADC is synchronized with MicroTCA Timing System
- sampleFirstBunch:
    Sample number of the first bunch
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- bunchPatternNode:
    Set up bunch pattern decoding parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters

Release History
2.8.3-2.11.1

Created: | 2021-06-25T11:42:45.000Z
Author: | Gabriele Giovanetti
Notes: | FIX: timeAxis maxSize that was wrong, and breaking middlelayers

2.8.2-2.11.1

Created: | 2021-06-15T17:42:44.000Z
Author: | Wajid Ehsan
Notes: | Fix bunch period issue

2.8.1-2.11.1

Created: | 2021-06-15T16:00:03.000Z
Author: | Wajid Ehsan
Notes: | Update depends tag

2.8.0-2.11.1

Created: | 2021-06-11T14:21:15.000Z
Author: | Bruno Fernandes
Notes: | FastADC firmware 3.5.21

2.7.8-2.11.1

Created: | 2021-06-09T09:37:55.000Z
Author: | Wajid Ehsan
Notes: | update tag for iibus

2.7.7-2.11.1

Created: | 2021-06-02T16:15:10.000Z
Author: | Wajid Ehsan
Notes: | Fix indentation issues

2.7.6-2.10.0

Created: | 2021-06-02T07:25:59.000Z
Author: | Bruno Fernandes
Notes: | Raw and peak data in Voltage levels

2.7.6-2.10.0-only_for_laslab

Created: | 2021-02-04T13:52:10.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Karabo 2.10 Versioning Info added to LASLAB branch (new features)

2.7.5-2.10.0

Created: | 2020-11-26T11:52:36.000Z
Author: | Steffen Hauf
Notes: | Swapped TCLKA and TCLKB values.

2.7.4-2.10.0

Created: | 2020-11-24T13:31:13.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

2.7.3-2.9.1

Created: | 2020-09-23T15:43:01.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Bug/Fix: Replace fixedBaselineEna with useDynamicBaseline

2.7.2-2.9.0

Created: | 2020-09-11T14:25:10.000Z
Author: | Wajid Ehsan
Notes: | Remove deprecated slots

2.7.1-2.9.0

Created: | 2020-09-10T08:12:17.000Z
Author: | Robert Schaffer
Notes: | For Firmware version 3.5

2.7.0-2.9.0

Created: | 2020-09-09T17:36:37.000Z
Author: | Robert Schaffer
Notes: |

2.6.4-2.6.1-only_for_laslab

Created: | 2019-11-26T12:38:00.000Z
Author: | Riccardo Fabbri
Notes: | Train statistics included in special branch dedicated to laslab.

2.6.3-2.6.1

Created: | 2019-11-12T12:27:17.000Z
Author: | Denys Mamchyk
Notes: | fix for “Raw Delay” and “Pulse Delay” max limits

2.6.2-2.5.0

Created: | 2019-07-11T07:56:32.000Z
Author: | Riccardo Fabbri
Notes: | BugFix: wipeRawPipelineData: Nr of channels in loop corrected

2.6.1-2.4.0

Created: | 2019-06-20T11:01:02.000Z
Author: | Steffen Hauf
Notes: |

2.6.0-2.4.0

Created: | 2019-06-03T10:58:20.000Z
Author: | Steffen Hauf
Notes: | Add the fasterADC device, which only outputs raw data

2.5.0-2.4.0

Created: | 2019-05-02T15:15:13.000Z
Author: | Alessandro Silenzi
Notes: | FIX: avoid sending old data if RAW not ready Documentation

###### 3

Instance id: | LA1_LAS_PPL/ADC/3
Class id: | FastAdc
Host: | spb-rr-sys-con-camopt
Class documentation:
| FastAdc
Alias: | spb-rr-sys-con-camopt
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/fastAdc
Last modified: | 2021-07-01T18:38:03.000+02:00
Created at: | 2016-12-22T15:17:58.000+01:00
Main authors: | Fernandes, Ehsan, Ehsanw
Latest tag: | 2.8.3-2.11.1
Deployment tag: | 2.8.3-2.11.1
Scenes: | PPL_Photodiodes
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Installation not found in a standard path!

Fast ADC

The `FastADC` device is documented in fastadc:welcome

Trouble Shooting

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

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

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

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- digitizerFrequency:
    ADC sampling frequency.
- adcRange:
    Voltage range (peak to peak) of ADC chips.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Time delay between trigger and start of raw data acquisition.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- timeAxis:
    Time of sample (relative to trigger signal).
- rawDataMode:
    Determines the conditions under which raw data is acquired. If ‘conditional’, only acquire raw data when the train has bunches for the current Bunch Pattern decoder configuration.
- rawDynamic:
    When true, raw acquisition starts at the first bunch for the current Bunch Pattern decoder configuration.
- triggerTime:
    Time between Triggers
- trainId:
    Current train ID as read from the FPGA
- timingSync:
    Timing Sync status as read from The FPGA. When true, FastADC is synchronized with MicroTCA Timing System
- sampleFirstBunch:
    Sample number of the first bunch
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- bunchPatternNode:
    Set up bunch pattern decoding parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters

Release History
2.8.3-2.11.1

Created: | 2021-06-25T11:42:45.000Z
Author: | Gabriele Giovanetti
Notes: | FIX: timeAxis maxSize that was wrong, and breaking middlelayers

2.8.2-2.11.1

Created: | 2021-06-15T17:42:44.000Z
Author: | Wajid Ehsan
Notes: | Fix bunch period issue

2.8.1-2.11.1

Created: | 2021-06-15T16:00:03.000Z
Author: | Wajid Ehsan
Notes: | Update depends tag

2.8.0-2.11.1

Created: | 2021-06-11T14:21:15.000Z
Author: | Bruno Fernandes
Notes: | FastADC firmware 3.5.21

2.7.8-2.11.1

Created: | 2021-06-09T09:37:55.000Z
Author: | Wajid Ehsan
Notes: | update tag for iibus

2.7.7-2.11.1

Created: | 2021-06-02T16:15:10.000Z
Author: | Wajid Ehsan
Notes: | Fix indentation issues

2.7.6-2.10.0

Created: | 2021-06-02T07:25:59.000Z
Author: | Bruno Fernandes
Notes: | Raw and peak data in Voltage levels

2.7.6-2.10.0-only_for_laslab

Created: | 2021-02-04T13:52:10.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Karabo 2.10 Versioning Info added to LASLAB branch (new features)

2.7.5-2.10.0

Created: | 2020-11-26T11:52:36.000Z
Author: | Steffen Hauf
Notes: | Swapped TCLKA and TCLKB values.

2.7.4-2.10.0

Created: | 2020-11-24T13:31:13.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

2.7.3-2.9.1

Created: | 2020-09-23T15:43:01.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Bug/Fix: Replace fixedBaselineEna with useDynamicBaseline

2.7.2-2.9.0

Created: | 2020-09-11T14:25:10.000Z
Author: | Wajid Ehsan
Notes: | Remove deprecated slots

2.7.1-2.9.0

Created: | 2020-09-10T08:12:17.000Z
Author: | Robert Schaffer
Notes: | For Firmware version 3.5

2.7.0-2.9.0

Created: | 2020-09-09T17:36:37.000Z
Author: | Robert Schaffer
Notes: |

2.6.4-2.6.1-only_for_laslab

Created: | 2019-11-26T12:38:00.000Z
Author: | Riccardo Fabbri
Notes: | Train statistics included in special branch dedicated to laslab.

2.6.3-2.6.1

Created: | 2019-11-12T12:27:17.000Z
Author: | Denys Mamchyk
Notes: | fix for “Raw Delay” and “Pulse Delay” max limits

2.6.2-2.5.0

Created: | 2019-07-11T07:56:32.000Z
Author: | Riccardo Fabbri
Notes: | BugFix: wipeRawPipelineData: Nr of channels in loop corrected

2.6.1-2.4.0

Created: | 2019-06-20T11:01:02.000Z
Author: | Steffen Hauf
Notes: |

2.6.0-2.4.0

Created: | 2019-06-03T10:58:20.000Z
Author: | Steffen Hauf
Notes: | Add the fasterADC device, which only outputs raw data

2.5.0-2.4.0

Created: | 2019-05-02T15:15:13.000Z
Author: | Alessandro Silenzi
Notes: | FIX: avoid sending old data if RAW not ready Documentation

##### ASENS

[add component documentation]

###### AI_SIGNAL_BOX_CH1

Instance id: | LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH1
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    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!
- start:
    Instructs device to go to started state
- stop:
    Instructs device to go to stopped state
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Time delay between trigger and start of raw data acquisition.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.

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

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

###### AI_SIGNAL_BOX_CH2

Instance id: | LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH2
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    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!
- start:
    Instructs device to go to started state
- stop:
    Instructs device to go to stopped state
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Time delay between trigger and start of raw data acquisition.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.

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

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

###### AI_SIGNAL_BOX_CH3

Instance id: | LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH3
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    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!
- start:
    Instructs device to go to started state
- stop:
    Instructs device to go to stopped state
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Time delay between trigger and start of raw data acquisition.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.

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

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

###### AI_SIGNAL_BOX_CH4

Instance id: | LA1_LAS_PPL/ASENS/AI_SIGNAL_BOX_CH4
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    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!
- start:
    Instructs device to go to started state
- stop:
    Instructs device to go to stopped state
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Time delay between trigger and start of raw data acquisition.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.

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

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

###### EMETER_AMPHOS_DIAG

###### EMETER_NOPA_FXE_3

###### EMETER_NOPA_SPB_3

###### EMETER_UNCOMP_FXE_OUT

###### EMETER_UNCOMP_SPB_OUT

###### GUIDELASER_FXE_CTL_OUT

Instance id: | LA1_LAS_PPL/ASENS/GUIDELASER_FXE_CTL_OUT
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    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!
- start:
    Starts an acquisition
- stop:
    Stops an acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Time delay between trigger and start of raw data acquisition.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.

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

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

###### GUIDELASER_SPB_CTL_OUT

Instance id: | LA1_LAS_PPL/ASENS/GUIDELASER_SPB_CTL_OUT
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    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!
- start:
    Starts an acquisition
- stop:
    Stops an acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Time delay between trigger and start of raw data acquisition.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.

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

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

###### HUMIDITY

Instance id: | LA1_LAS_PPL/ASENS/HUMIDITY
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    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!
- start:
    Starts an acquisition
- stop:
    Stops an acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Time delay between trigger and start of raw data acquisition.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.

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

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

##### CAM

[add component documentation]

###### AC_FXE_DIAG

###### AC_SPB_DIAG

###### AMPHOS_FF

###### AMPHOS_INPUT_NF

###### AMPHOS_NF

###### FE_XF1_FF

###### FE_XF1_NF

###### FE_XF2_NF

###### FXE_Instr_1

###### FXE_Instr_2

###### FXE_Instr_3

###### FXE_SEED

###### FXE_UNCOMP

###### GALVO_FXE

###### GALVO_SPB

###### NOPA_FXE_1

###### NOPA_FXE_2

###### NOPA_FXE_3

###### NOPA_SPB_1

###### NOPA_SPB_2

###### NOPA_SPB_3

###### SPB_Instr_1

###### SPB_Instr_2

###### SPB_Instr_3

###### SPB_SEED

###### SPB_UNCOMP

###### XF1DIAG_SPB_TEM

##### DCTRL

[add component documentation]

###### CMCOMPSTAGE

Instance id: | LA1_LAS_PPL/DCTRL/CMCOMPSTAGE
Host: | exflcon14n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

Device Schema Description

- _serverId_:

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

- _deviceId_:

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

- _connection_:

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

- visibility:

    Configures who is allowed to see this device at all

- deviceId:

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

- classId:

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

- classVersion:

    The version of the class of this device defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- alarmCondition:

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

- lastCommand:

    The last slot called.

- archive:

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

- useTimeserver:

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

- progress:

    The progress of the current action

- heartbeatInterval:

    The heartbeat interval

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

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

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

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

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

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

- epsilon:

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

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

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

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

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

- maxStateUpdateRate:

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

- noisyStateUpdateRateValue:

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

- isStateUpdateNoisy:

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

- reset:

    Resets the PLC hardware

- enableInterlockedSlots:

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

- disableInterlockedSlots:

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

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

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

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

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

- readHardware:

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

- force:

    ???

- trigger:

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

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- value:

    Analog input of ADC.

- scale:

    Scaling factor for analog value.

- offset:

    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!

- start:

    Instructs device to go to started state

- stop:

    Instructs device to go to stopped state

- resetADC:

    Reset ADC’s of FPGA in case of constant line, No signal

- resetDDR2:

    Resets DDR2 in case of constant line, No signal

- deviceFile:

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

- mapDirectory:

    Folder where all xml mapping files are located.

- numberRawSamples:

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

- delay:

    Delay between calibration images.

- skipSamples:

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

- triggerTime:

    Time between Triggers

- triggerTimeStat:

    Histogram of time between Triggers

- trainId:

    Current train ID as read from the FPGA

- config:

    Board related configuration parameters.

- dacNode:

    Set up DAC parameters

- channel_0:

    This is a channel of bunch of other parameters

- channel_1:

    This is a channel of bunch of other parameters

- channel_2:

    This is a channel of bunch of other parameters

- channel_3:

    This is a channel of bunch of other parameters

- channel_4:

    This is a channel of bunch of other parameters

- channel_5:

    This is a channel of bunch of other parameters

- channel_6:

    This is a channel of bunch of other parameters

- channel_7:

    This is a channel of bunch of other parameters

- channel_8:

    This is a channel of bunch of other parameters

- channel_9:

    This is a channel of bunch of other parameters

- semiRawValue:

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

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- timeServerId:

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

- Logger:

    Logging settings

- sendCommand:

    Send command to the instrument.

- replyToCommand:

    Reply to the command send to the instrument.

- gotoErrorOnPollFailure:

    Instrument will go to error if poll fails for all properties.

- autoConnect:

    Set True to automatically connect to device.

- pollingInterval:

    The interval for polling the instrument.

- enableHeartbeat:

    Enable Heartbeat

- heartbeatCommand:

    Text to send as heartbeat

- heartbeatReply:

    Heartbeat reply text

- heartbeatPeriod:

    Heartbeat period

- heartbeatTime:

    Last heartbeat time

- pollingTimeTaken:

    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

- pollNow:

    Poll instrument now!

- _connect_:

    Connects to the device

- disconnect:

    Disconnects from the device

- handshake:

    Set the state of the message roundtrip handshaking.

- baudRate:

    Set the transmit and receive baud rates on the RS-232 port.

- errorCount:

    The number of error records in the queue.

- measureType:

    Set the meter measurement mode (energy or power).

- statisticsMode:

    Set the statistics processing mode (on or off).

- variableDecimation:

    Set the pulse decimation rate (1-99999).

- apertureDiameter:

    Set the aperture diameter.

- wavelength:

    Set the current wavelength.

- gainCompensation:

    Enables or disables the gain compensation.

- gainFactor:

    Set the gain compensation factor.

- range:

    Set the measurement range (maximum expected measurement).

- batchSize:

    Set the statistics batch size.

- restartMode:

    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

- statStart:

    Terminates the current statistical batch and start a new one.

- statStop:

    Terminates the current statistical batch.

- triggerSource:

    Selects the trigger source (INTernal / EXTernal).

- triggerLevel:

    Set the trigger level (no effect when external trigger is selected).

- triggerSlope:

    Selects the external trigger edge (POSitive / NEGative).

- sequenceId:

    Set the sequence ID.

- triggerBus:

    Selects the trigger bus participation mode.

- itemSelect:

    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

- statItemSelect:

    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

- serialNumber:

    The serial number string.

- partNumber:

    The part number.

- modelName:

    The Model Name.

- calibrationDate:

    The calibration date.

- manifacturingDate:

    The manifacturing date.

- defaultWavelength:

    The default wavelength.

- measurementRefreshRate:

    The refresh rate of measurements.

- measurement:

    Last measurement.

- idType:

    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

- cameraId:

    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

- packetDelay:

    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

- autoPacketSize:

    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

- packetSize:

    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

- exposureTime:

    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

- triggerMode:

    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

- triggerActivation:

    This enumeration sets the signal transition needed to activate the selected trigger.

- autoGain:

    Configures automatic gain feature.

- gain:

    Sets the gain of the ADC converter.

- acquisitionMode:

    This property sets the image acquisition mode.

- frameCount:

    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

- xPeak1:

    x-position of peak in first calibration image.

- xFWHM1:

    x-FWHM in first calibration image.

- xPeak2:

    x-position of peak in second calibration image.

- xFWHM2:

    x-FWHM in second calibration image.

- delayUnit:

    Unit of the delay between calibration images.

- useAsCalibrationImage1:

    Use the current image as 1st calibration image.

- useAsCalibrationImage2:

    Use the current image as 2nd calibration image.

- calibrate:

  > perform calibrationStepsNumber steps of calibrationStep size starting and ending in symmetrical places relatively to initial position, both along X and Y, while measuring center of beam position.

  > Use these measurements to calculate axCoef and ayCoef.

  > Assumptions that are made: sin(x) ~= x x(y) axis of TEM parallel to x (y) axis of camera

- calibrationFactor:

    The calibration constant.

- beamShape:

    Time shape of the beam.

- xMinFit:

    Lower limit for the fit.

- xMaxFit:

    Upper limit for the fit.

- fitStatus:

    Error of fit procedure: 1-3 means good fit. See device documentation for further details.

- subtractPedestal:

    Subtract the pedestal, calculated from linear interpolation between first and last point.

- xPeak3:

    x-position of peak in the input image.

- xFWHM3:

    x-FWHM in the input image.

- pulseWidth:

    Duration of the pulse.

- ePulseWidth:

    Uncertainty of the pulse duration arising from fit procedure.

- switchToReady:

    Instructs the amplifier to go to ready state.

- switchOn:

    Instructs the amplifier to go to on state.

- switchOff:

    Instructs the amplifier to go to off state.

- closeShutter2:

    Instructs the amplifier to close Shutter 2.

- openShutter2:

    Instructs the amplifier to open Shutter 2.

- amphosIp:

    The IP address of the Amphos Control.

- amphosPort:

    The port of the Amphos Control.

- stateChanging:

    Laser is currently changing state.

- targetPower:

    Target laser power.

- chillerTemperature:

    Measured temperature of chiller.

- chillerFlow:

    Measured flow of chiller [l/min].

- chillerValvePosition:

    Measured valve position.

- shutter2IsOpen:

    Shutter2 State: False=closed True=open

- lambdaIsBusy:

    Lambda plate is moving.

- laserCurrent:

    Measured current of Amphos400.

- laserTemperature:

    Measured temperature of Amphos400.

- laserHumidity:

    Measured humidity of Amphos400.

- xfelCurrentCW1:

    Measured current of XFEL booster 1 (CW1).

- xfelCurrentCW2:

    Measured current of XFEL booster 1 (CW2).

- xfelCurrentQCW1:

    Measured current of XFEL booster 1 (QCW1).

- xfelCurrentQCW2:

    Measured current of XFEL booster 1 (QCW2).

- xfelCurrentQCW3:

    Measured current of XFEL booster 1 (QCW3).

- xfelCurrentQCW4:

    Measured current of XFEL booster 1 (QCW3).

- xfelTemperature:

    Measured temperature of XFEL booster 1.

- xfelHumidity:

    Measured humidity of XFEL booster 1.

- globalAlarmCondition:

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

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- log:

    Logging settings

- adc:

    fast ADC input device

- selectedAdcChannel:

    fast ADC channel in use for the loop

- maxPeakValue:

    Max absolute value for ADC peak. When peak is above this value step is applied

- tuneStage:

    motor controlling the stage to adjust laser path

- stageStep:

    value of stage tuning step size

- loopPeriod:

    Time interval for feedback cycle

- doublecheckWaitTime:

    after peak is above max, this time is waiting to check itagain, before applying step

- calibStepSize:

    Size of calibration step

- calibStepNum:

    Number of calibration steps

- calibAverageNum:

    number of peak values to be averaged for each calibration step

- reverseDirection:

    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

- conversionFactor:

    micrometers to femtoseconds conversion factor

- adcValueTimeout:

    if ADC value is not updated within this time, device goesin error state

- amphosAmpli:

    Karabo ID of Amphos Laser Amplifier

- triggerDelayDevice:

    Karabo ID of pplDelayControl device, used to read Pockels cell status

- moveToPlus:

    Move to +x position

- moveToMinus:

    Move to -x position

- moveToZero:

    Move to 0 position

- pathToProgramFiles:

    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

- correctionFile:

    The correction (.ct5) file, including path.

- useExternalTrigger:

    Use external trigger (if true) or auto-run (if false).

- startFromMinusX:

    Set loop initial position to -X

- jumpSpeed:

    The up/down jump speed [bits/ms].

- jumpAmplitude:

    The up/down jump amplitude [bits].

- delayTimePlus:

    Delay time, after moving to position +x.

- delayTimeMinus:

    Delay time, after moving to position -x.

- onTargetTolerance:

    The tolerance [bits] when checking that Galvo is on target position.

- onTargetPlus:

    Galvo is currently at +x position _and_ not moving.

- onTargetMinus:

    Galvo is currently at -x position _and_ not moving.

- laserOn:

    The value of the LASERON signal.

- digitalOut1:

    The value of the DIGITAL OUT1 signal.

- stopEventCode:

    Stop event code.

- galvoTemperature:

    Galvanometer scanner temperature.

- servoTemperature:

    Servo board temperature.

- agcVoltage:

    AGC voltage (PD supply voltage).

- dspCoreVoltage:

    DSP core supply voltage (1.8 V).

- dspIoVoltage:

    DSP IO voltage (3.3 V).

- analogSectVoltage:

    Analog section voltage (9 V).

- adConverterVoltage:

    AD converter supply voltage (5 V).

- galvoHeatingOut:

    Relative heating output of the corresponding galvanometer scanner heater.

- beamline:

    Beamline where to operate

- timingDevice:

    Device ID of PPL Delay Control Device

- galvoDevice:

    id of Galvo Controller

- downstreamSpectr1Device:

    Spectrometer 1 (FXE/SCS)

- upstreamSpectr1Device:

    Spectrometer 1 (SPB/SQS)

- currentExperiment:

    Current MASTER experiment (UPSTREAM or DOWNSTREAM)

- currentVersion:

    Current version

- correctionFactorMaster:

    Correction Factor Master

- correctionFactorSlave:

    Correction Factor Slave

- switchProgress:

    Switching Progress

- switchExperiment:

    Procedure to automatically swap between FXE and SPB delay control and Galvo settings

- on:

    Instructs the device to switch on

- off:

    Instructs device to switch off

- lastError:

    Last error message received. Time is set by front-end firmware.

- scpiTimeout:

    The SCPI communication timeout.

- baseFreq:

    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

- frontendReset:

    send reset command

- s7ack:

    acknowledge to s7 command

- s8ack:

    acknowledge to s8 command

- s9ack:

    acknowledge to s9 command

- laserEmission:

    True when laser ON, false when OFF

- generalStatus:

    True = OK, False = not OK

- temperatureStatus:

    True = OK, False = not OK

- delayBoardStatus:

    True = OK, False = not OK

- inputPin0Status:

    True = OK, False = not OK

- inputPin4Status:

    True = OK, False = not OK

- pd1Voltage:

    Photodiode 1 (TAB 2) voltage

- pd1VoltageAverage:

    Averaged PD1 (TAB 2) voltage

- pd2Voltage:

    Photodiode 2 (TAB 5) voltage

- pd2VoltageAverage:

    Averaged PD2 (TAB 5) voltage

- pd3Voltage:

    PD3 (SPCO 1) voltage

- pd3VoltageAverage:

    Averaged PD3 (SPCO 1) voltage

- pd4Voltage:

    PD4 (TAB 7) voltage

- pd4VoltageAverage:

    Averaged PD4 (TAB 7) voltage

- pd5Voltage:

    PD5 (SPCO2) voltage

- pd5VoltageAverage:

    Averaged PD5 (SPCO2) voltage

- pd6Voltage:

    PD6 voltage

- pd6VoltageAverage:

    Averaged PD6 voltage

- pd7Voltage:

    PD7 voltage

- pd7VoltageAverage:

    Averaged PD7 voltage

- pd8Voltage:

    PD8 voltage

- pd8VoltageAverage:

    Averaged PD8 voltage

- seederOutPower:

    photodiode 1

- xf1OutPower:

    Photodiode 7

- xf2OutPower:

    Photodiode 8

- seederStatus:

    True = OK, False = not OK

- generalSeederStatus:

    True = OK, False = not OK

- hiltiErrorStatus:

    True = OK, False = not OK

- remoteControl:

    if it is false we cannot see it

- regOnOff0:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- regOnOff1:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- setpAX0:

    Variable SetpAx[0] define the setpoint of the servo loop.

- setpAY0:

    Variable SetpAy[0] define the setpoint of the servo loop.

- sumA0:

    Sum signal of angle detector ‘A’

- sumB0:

    Sum signal of position detector ‘B’

- aX0:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY0:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX0:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY0:

    Variable By represents the measured position deviation in y direction from zero position

- rAX0:

    Regulator Output Ax

- rAY0:

    Regulator Output Ay

- rBX0:

    Regulator Output Bx

- rBY0:

    Regulator Output By

- rAXM0:

    Regulator Output AxM

- rAYM0:

    Regulator Output AyM

- rBXM0:

    Regulator Output BxM

- rBYM0:

    Regulator Output ByM

- setpAX1:

    Variable SetpAx[1] define the setpoint of the servo loop.

- setpAY1:

    Variable SetpAy[1] define the setpoint of the servo loop.

- sumA1:

    Sum signal of angle detector ‘A’

- sumB1:

    Sum signal of position detector ‘B’

- aX1:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY1:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX1:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY1:

    Variable By represents the measured position deviation in y direction from zero position

- rAX1:

    Regulator Output Ax

- rAY1:

    Regulator Output Ay

- rBX1:

    Regulator Output Bx

- rBY1:

    Regulator Output By

- rAXM1:

    Regulator Output AxM

- rAYM1:

    Regulator Output AyM

- rBXM1:

    Regulator Output BxM

- rBYM1:

    Regulator Output ByM

- stage1Id:

    Karabo device ID of first grating motor

- stage2Id:

    Karabo device ID of first grating motor

- tunnel:

    Location where doocs_device is deployed (e.g. ‘SASE1’)

- labx2MName:

    DOOCS name of X2 Master doocs_device

- labx2SName:

    DOOCS name of X2 Slave doocs_device

- timingShifterName:

    DOOCS name of Phase Shifter doocs_device

- manualTuning:

    Manual Tuning Enable

- useShifter:

    Set to True if optical synchronization is available

- midTsValue:

    Mid Value of Phase Shifter

- maxTsDelay:

    Maximum delay to add/subtract to phase shifter position

- maxTsJitter:

    Maximum allowed jitter

- laserOpModeList:

    Select Laser Op Mode

- activeLaserOpMode:

    Active Op laser Mode

- laserOpModeListApply:

    Apply Laser Operation Mode

- dmBCCAuto:

    Automatic loop on/off

- pCellState:

    Status of Pockels Cell, True = On

- pCellOn:

    Set Pockels cell on

- pCellOff:

    Set Pockels cell off

- AOMState:

    Status of AOM, True = On

- AOMOn:

    Set AOM on

- AOMOff:

    Set AOM off

- maxAllowedPcPhase:

    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

- mPCCLKPhase:

    Master PC Phase

- mSWPCCLKPhase:

    Master SW PC Phase

- mBurstWidth:

    Master burst width [us]

- mBurstWidthApply:

    Apply m Burst Width

- mBurstStart:

    Begining of the bursts the slave burst is +50ms)

- mBurstStartsms:

    Master burst starts pos. [us]

- sBurstStartsms:

    Sleve burst starts pos. [us]

- smBurstDiff:

    Different between muster and slave burst positione

- sPCCLKPhase:

    Master PC Phase

- sSWPCCLKPhase:

    Slave software PC PHase

- sBurstWidth:

    Slave burst width [us]

- sBurstWidthApply:

    Apply S Burst width

- delayBPMaster:

    Current delay of the master bunch pattern in clock unit (machine)

- delayBPMasterP:

    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterM:

    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterP24:

    Increment Master Bunch Pattern delay by 24 clock unit

- delayBPMasterM24:

    Decrement Master Bunch Pattern delay by 24 clock unit

- delayBPSlave:

    Current delay of the slave bunch pattern in clock unit (machine)

- delayBPSlaveP:

    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveM:

    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveP24:

    Increment Slave Bunch Pattern delay by 24 clock unit

- delayBPSlaveM24:

    Decrement Slave Bunch Pattern delay by 24 clock unit

- masterExpPattern:

    Select pattern for master experiment

- slaveExpPattern:

    Select pattern for slave experiment

- currentLaserPatterns:

    Current Laser Patterns

- currentMasterLaserPattern:

    Current Master Laser Patterns

- currentSlaveLaserPattern:

    Current Slave Laser Patterns

- currentSlaveLaserPatternN:

    Current Slave Laser Pattern

- fineDelayMaxCounts:

    Fine delay - maximum count number

- fineDelayValue:

    fine delay count value

- fineDelayValueT:

    fine delay time value

- fineDelayP:

    Increment fine delay

- fineDelayM:

    Decrement fine delay

- fineDelay9nsChange:

    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

- fineDelay9ns:

    Change Fine Delay by 9 ns

- minTsPosition:

    Minimum Timing Shifter Delay

- maxTsPosition:

    Maximum Timing Shifter Delay

- currentTsPosition:

    current value of time shifter position

- requestedTsDelay:

    Delay to apply to the phase shifter

- DelayTsChange:

    Change phase shifter by requested value

- relAbsolutTsPos:

    True for relative, False for absolute

- stopPsChange:

    Abort phase shift change

- opticalSynch:

    Display status of optical synchronization

- opticalSynchLock:

    Display lock status of optical synchronization

- opticalSynchJitter:

    Display status of optical synchronization jitter

- opticalSynchMode:

    Optical synch. mode (RF / Optical)

- setOpticalDelay:

    Delay to apply to optical delay line

- applyOpticalDelay:

    change the optical delay by requeste value

- currentOpticalDelay:

    Current position of optical delay

- relAbsolutDelayLine:

    True for relative, False for absolute

- TsJitter:

    Optical Synchronization Jitter

- triggerFE_DOWNSTREAM:

    Current trigger delay FE DOWNSTREAM

- triggerFE_UPSTREAM:

    Current trigger delay FE UPSTREAM

- getCurrentHardwareStatus:

    Read configuration from hardware

- lastShiftDelay:

    FE delay value from the prevoius shift

- setLastShiftDelay:

    Bring the delay to position from the previus shift

- clearLock:

    In case of STATE == changing bring the state to Normal

- mPCCLKPhaseSetValue:

    Master PC CLK Phase Value

- sPCCLKPhaseSetValue:

    Slave PC CLK Phase Value

- delayBPMasterSetValue:

    Master BP delay Value

- delayBPSlaveSetValue:

    Slave BP delay Value

- resetError:

    Reset error state

- upstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for upstream instrument

- downstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for downstream instrument

- shiftChange:

    Swaps MASTER and SLAVE properties between upstream and downstream instrument

- isOxcActive:

    Status of optical lock (True: OPTICAL mode, False: RF mode)

- requestedDelay:

    Relative delay to be applied by delay change (Trigger Position)

- delayChange:

    Change delay value by applying (relative) offset

- mPCCLKPhaseP:

    Increment PC master Phase

- mPCCLKPhaseM:

    Decrement PC master Phase

- sPCCLKPhaseP:

    Increment slave PC Phase

- sPCCLKPhaseM:

    Decrement slave PC phase

- savemSWPCCLKPhase:

    Save new software phase value for PCm

- savesSWPCCLKPhase:

    Save new software phase value for PCs

- mBurstStartApply:

    Apply Burst Start Pos

- takemidTsValue:

    Take mid value of phase shifter

- logBoardsStatus:

    JSON string describing master and slave board settings.Usually updated when user actions are taken

- logFineDelay:

    JSON string describing fine delay settings.Usually updated when user actions are taken

- imgprocDevice:

    Device ID of image processor used for feedback

- temDevice:

    id of tem device

- temChannel:

    TEM channel to be controlled

- xCoefWeight:

    weight of X coefficient

- yCoefWeight:

    weight of Y coefficient

- axCoefOld:

    Value of Ax Coefficient saved prior to calibration

- ayCoefOld:

    Value of Ay Coefficient saved prior to calibration

- xBeamCenterTarget:

    desired value for Beam Center X coordinate

- yBeamCenterTarget:

    desired value for Beam Center Y coordinate

- beamCenterMaxDisplacement:

    maximum allowed displacement for Center of Mass from target position

- maxTemDrift:

    Maximum value allowed for TEM drift

- averageNumber:

    number of values of beam center coordinates to average

- timeoutImageProcessorValues:

    Time to wait before going in error when values from image processor are not updating

- imageSettlementTime:

    Time to wait before reading beam center coordinates aftermoving TEM setpoint

- calibrationStep:

    TEM setpoint step size for calibration

- calibrationStepsNumber:

    Number of TEM calibration steps

- maxTimeNotRegulating:

    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

- setCurrentPosAsTarget:

    Set current beam position as target

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

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

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

###### DMCOMPSTAGE

Instance id: | LA1_LAS_PPL/DCTRL/DMCOMPSTAGE
Host: | exflcon14n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

Device Schema Description

- _serverId_:

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

- _deviceId_:

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

- _connection_:

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

- visibility:

    Configures who is allowed to see this device at all

- deviceId:

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

- classId:

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

- classVersion:

    The version of the class of this device defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- alarmCondition:

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

- lastCommand:

    The last slot called.

- archive:

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

- useTimeserver:

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

- progress:

    The progress of the current action

- heartbeatInterval:

    The heartbeat interval

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

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

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

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

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

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

- epsilon:

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

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

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

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

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

- maxStateUpdateRate:

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

- noisyStateUpdateRateValue:

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

- isStateUpdateNoisy:

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

- reset:

    Resets the PLC hardware

- enableInterlockedSlots:

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

- disableInterlockedSlots:

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

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

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

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

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

- readHardware:

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

- force:

    ???

- trigger:

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

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- value:

    Analog input of ADC.

- scale:

    Scaling factor for analog value.

- offset:

    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!

- start:

    Instructs device to go to started state

- stop:

    Instructs device to go to stopped state

- resetADC:

    Reset ADC’s of FPGA in case of constant line, No signal

- resetDDR2:

    Resets DDR2 in case of constant line, No signal

- deviceFile:

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

- mapDirectory:

    Folder where all xml mapping files are located.

- numberRawSamples:

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

- delay:

    Delay between calibration images.

- skipSamples:

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

- triggerTime:

    Time between Triggers

- triggerTimeStat:

    Histogram of time between Triggers

- trainId:

    Current train ID as read from the FPGA

- config:

    Board related configuration parameters.

- dacNode:

    Set up DAC parameters

- channel_0:

    This is a channel of bunch of other parameters

- channel_1:

    This is a channel of bunch of other parameters

- channel_2:

    This is a channel of bunch of other parameters

- channel_3:

    This is a channel of bunch of other parameters

- channel_4:

    This is a channel of bunch of other parameters

- channel_5:

    This is a channel of bunch of other parameters

- channel_6:

    This is a channel of bunch of other parameters

- channel_7:

    This is a channel of bunch of other parameters

- channel_8:

    This is a channel of bunch of other parameters

- channel_9:

    This is a channel of bunch of other parameters

- semiRawValue:

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

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- timeServerId:

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

- Logger:

    Logging settings

- sendCommand:

    Send command to the instrument.

- replyToCommand:

    Reply to the command send to the instrument.

- gotoErrorOnPollFailure:

    Instrument will go to error if poll fails for all properties.

- autoConnect:

    Set True to automatically connect to device.

- pollingInterval:

    The interval for polling the instrument.

- enableHeartbeat:

    Enable Heartbeat

- heartbeatCommand:

    Text to send as heartbeat

- heartbeatReply:

    Heartbeat reply text

- heartbeatPeriod:

    Heartbeat period

- heartbeatTime:

    Last heartbeat time

- pollingTimeTaken:

    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

- pollNow:

    Poll instrument now!

- _connect_:

    Connects to the device

- disconnect:

    Disconnects from the device

- handshake:

    Set the state of the message roundtrip handshaking.

- baudRate:

    Set the transmit and receive baud rates on the RS-232 port.

- errorCount:

    The number of error records in the queue.

- measureType:

    Set the meter measurement mode (energy or power).

- statisticsMode:

    Set the statistics processing mode (on or off).

- variableDecimation:

    Set the pulse decimation rate (1-99999).

- apertureDiameter:

    Set the aperture diameter.

- wavelength:

    Set the current wavelength.

- gainCompensation:

    Enables or disables the gain compensation.

- gainFactor:

    Set the gain compensation factor.

- range:

    Set the measurement range (maximum expected measurement).

- batchSize:

    Set the statistics batch size.

- restartMode:

    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

- statStart:

    Terminates the current statistical batch and start a new one.

- statStop:

    Terminates the current statistical batch.

- triggerSource:

    Selects the trigger source (INTernal / EXTernal).

- triggerLevel:

    Set the trigger level (no effect when external trigger is selected).

- triggerSlope:

    Selects the external trigger edge (POSitive / NEGative).

- sequenceId:

    Set the sequence ID.

- triggerBus:

    Selects the trigger bus participation mode.

- itemSelect:

    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

- statItemSelect:

    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

- serialNumber:

    The serial number string.

- partNumber:

    The part number.

- modelName:

    The Model Name.

- calibrationDate:

    The calibration date.

- manifacturingDate:

    The manifacturing date.

- defaultWavelength:

    The default wavelength.

- measurementRefreshRate:

    The refresh rate of measurements.

- measurement:

    Last measurement.

- idType:

    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

- cameraId:

    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

- packetDelay:

    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

- autoPacketSize:

    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

- packetSize:

    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

- exposureTime:

    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

- triggerMode:

    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

- triggerActivation:

    This enumeration sets the signal transition needed to activate the selected trigger.

- autoGain:

    Configures automatic gain feature.

- gain:

    Sets the gain of the ADC converter.

- acquisitionMode:

    This property sets the image acquisition mode.

- frameCount:

    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

- xPeak1:

    x-position of peak in first calibration image.

- xFWHM1:

    x-FWHM in first calibration image.

- xPeak2:

    x-position of peak in second calibration image.

- xFWHM2:

    x-FWHM in second calibration image.

- delayUnit:

    Unit of the delay between calibration images.

- useAsCalibrationImage1:

    Use the current image as 1st calibration image.

- useAsCalibrationImage2:

    Use the current image as 2nd calibration image.

- calibrate:

  > perform calibrationStepsNumber steps of calibrationStep size starting and ending in symmetrical places relatively to initial position, both along X and Y, while measuring center of beam position.

  > Use these measurements to calculate axCoef and ayCoef.

  > Assumptions that are made: sin(x) ~= x x(y) axis of TEM parallel to x (y) axis of camera

- calibrationFactor:

    The calibration constant.

- beamShape:

    Time shape of the beam.

- xMinFit:

    Lower limit for the fit.

- xMaxFit:

    Upper limit for the fit.

- fitStatus:

    Error of fit procedure: 1-3 means good fit. See device documentation for further details.

- subtractPedestal:

    Subtract the pedestal, calculated from linear interpolation between first and last point.

- xPeak3:

    x-position of peak in the input image.

- xFWHM3:

    x-FWHM in the input image.

- pulseWidth:

    Duration of the pulse.

- ePulseWidth:

    Uncertainty of the pulse duration arising from fit procedure.

- switchToReady:

    Instructs the amplifier to go to ready state.

- switchOn:

    Instructs the amplifier to go to on state.

- switchOff:

    Instructs the amplifier to go to off state.

- closeShutter2:

    Instructs the amplifier to close Shutter 2.

- openShutter2:

    Instructs the amplifier to open Shutter 2.

- amphosIp:

    The IP address of the Amphos Control.

- amphosPort:

    The port of the Amphos Control.

- stateChanging:

    Laser is currently changing state.

- targetPower:

    Target laser power.

- chillerTemperature:

    Measured temperature of chiller.

- chillerFlow:

    Measured flow of chiller [l/min].

- chillerValvePosition:

    Measured valve position.

- shutter2IsOpen:

    Shutter2 State: False=closed True=open

- lambdaIsBusy:

    Lambda plate is moving.

- laserCurrent:

    Measured current of Amphos400.

- laserTemperature:

    Measured temperature of Amphos400.

- laserHumidity:

    Measured humidity of Amphos400.

- xfelCurrentCW1:

    Measured current of XFEL booster 1 (CW1).

- xfelCurrentCW2:

    Measured current of XFEL booster 1 (CW2).

- xfelCurrentQCW1:

    Measured current of XFEL booster 1 (QCW1).

- xfelCurrentQCW2:

    Measured current of XFEL booster 1 (QCW2).

- xfelCurrentQCW3:

    Measured current of XFEL booster 1 (QCW3).

- xfelCurrentQCW4:

    Measured current of XFEL booster 1 (QCW3).

- xfelTemperature:

    Measured temperature of XFEL booster 1.

- xfelHumidity:

    Measured humidity of XFEL booster 1.

- globalAlarmCondition:

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

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- log:

    Logging settings

- adc:

    fast ADC input device

- selectedAdcChannel:

    fast ADC channel in use for the loop

- maxPeakValue:

    Max absolute value for ADC peak. When peak is above this value step is applied

- tuneStage:

    motor controlling the stage to adjust laser path

- stageStep:

    value of stage tuning step size

- loopPeriod:

    Time interval for feedback cycle

- doublecheckWaitTime:

    after peak is above max, this time is waiting to check itagain, before applying step

- calibStepSize:

    Size of calibration step

- calibStepNum:

    Number of calibration steps

- calibAverageNum:

    number of peak values to be averaged for each calibration step

- reverseDirection:

    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

- conversionFactor:

    micrometers to femtoseconds conversion factor

- adcValueTimeout:

    if ADC value is not updated within this time, device goesin error state

- amphosAmpli:

    Karabo ID of Amphos Laser Amplifier

- triggerDelayDevice:

    Karabo ID of pplDelayControl device, used to read Pockels cell status

- moveToPlus:

    Move to +x position

- moveToMinus:

    Move to -x position

- moveToZero:

    Move to 0 position

- pathToProgramFiles:

    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

- correctionFile:

    The correction (.ct5) file, including path.

- useExternalTrigger:

    Use external trigger (if true) or auto-run (if false).

- startFromMinusX:

    Set loop initial position to -X

- jumpSpeed:

    The up/down jump speed [bits/ms].

- jumpAmplitude:

    The up/down jump amplitude [bits].

- delayTimePlus:

    Delay time, after moving to position +x.

- delayTimeMinus:

    Delay time, after moving to position -x.

- onTargetTolerance:

    The tolerance [bits] when checking that Galvo is on target position.

- onTargetPlus:

    Galvo is currently at +x position _and_ not moving.

- onTargetMinus:

    Galvo is currently at -x position _and_ not moving.

- laserOn:

    The value of the LASERON signal.

- digitalOut1:

    The value of the DIGITAL OUT1 signal.

- stopEventCode:

    Stop event code.

- galvoTemperature:

    Galvanometer scanner temperature.

- servoTemperature:

    Servo board temperature.

- agcVoltage:

    AGC voltage (PD supply voltage).

- dspCoreVoltage:

    DSP core supply voltage (1.8 V).

- dspIoVoltage:

    DSP IO voltage (3.3 V).

- analogSectVoltage:

    Analog section voltage (9 V).

- adConverterVoltage:

    AD converter supply voltage (5 V).

- galvoHeatingOut:

    Relative heating output of the corresponding galvanometer scanner heater.

- beamline:

    Beamline where to operate

- timingDevice:

    Device ID of PPL Delay Control Device

- galvoDevice:

    id of Galvo Controller

- downstreamSpectr1Device:

    Spectrometer 1 (FXE/SCS)

- upstreamSpectr1Device:

    Spectrometer 1 (SPB/SQS)

- currentExperiment:

    Current MASTER experiment (UPSTREAM or DOWNSTREAM)

- currentVersion:

    Current version

- correctionFactorMaster:

    Correction Factor Master

- correctionFactorSlave:

    Correction Factor Slave

- switchProgress:

    Switching Progress

- switchExperiment:

    Procedure to automatically swap between FXE and SPB delay control and Galvo settings

- on:

    Instructs the device to switch on

- off:

    Instructs device to switch off

- lastError:

    Last error message received. Time is set by front-end firmware.

- scpiTimeout:

    The SCPI communication timeout.

- baseFreq:

    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

- frontendReset:

    send reset command

- s7ack:

    acknowledge to s7 command

- s8ack:

    acknowledge to s8 command

- s9ack:

    acknowledge to s9 command

- laserEmission:

    True when laser ON, false when OFF

- generalStatus:

    True = OK, False = not OK

- temperatureStatus:

    True = OK, False = not OK

- delayBoardStatus:

    True = OK, False = not OK

- inputPin0Status:

    True = OK, False = not OK

- inputPin4Status:

    True = OK, False = not OK

- pd1Voltage:

    Photodiode 1 (TAB 2) voltage

- pd1VoltageAverage:

    Averaged PD1 (TAB 2) voltage

- pd2Voltage:

    Photodiode 2 (TAB 5) voltage

- pd2VoltageAverage:

    Averaged PD2 (TAB 5) voltage

- pd3Voltage:

    PD3 (SPCO 1) voltage

- pd3VoltageAverage:

    Averaged PD3 (SPCO 1) voltage

- pd4Voltage:

    PD4 (TAB 7) voltage

- pd4VoltageAverage:

    Averaged PD4 (TAB 7) voltage

- pd5Voltage:

    PD5 (SPCO2) voltage

- pd5VoltageAverage:

    Averaged PD5 (SPCO2) voltage

- pd6Voltage:

    PD6 voltage

- pd6VoltageAverage:

    Averaged PD6 voltage

- pd7Voltage:

    PD7 voltage

- pd7VoltageAverage:

    Averaged PD7 voltage

- pd8Voltage:

    PD8 voltage

- pd8VoltageAverage:

    Averaged PD8 voltage

- seederOutPower:

    photodiode 1

- xf1OutPower:

    Photodiode 7

- xf2OutPower:

    Photodiode 8

- seederStatus:

    True = OK, False = not OK

- generalSeederStatus:

    True = OK, False = not OK

- hiltiErrorStatus:

    True = OK, False = not OK

- remoteControl:

    if it is false we cannot see it

- regOnOff0:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- regOnOff1:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- setpAX0:

    Variable SetpAx[0] define the setpoint of the servo loop.

- setpAY0:

    Variable SetpAy[0] define the setpoint of the servo loop.

- sumA0:

    Sum signal of angle detector ‘A’

- sumB0:

    Sum signal of position detector ‘B’

- aX0:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY0:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX0:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY0:

    Variable By represents the measured position deviation in y direction from zero position

- rAX0:

    Regulator Output Ax

- rAY0:

    Regulator Output Ay

- rBX0:

    Regulator Output Bx

- rBY0:

    Regulator Output By

- rAXM0:

    Regulator Output AxM

- rAYM0:

    Regulator Output AyM

- rBXM0:

    Regulator Output BxM

- rBYM0:

    Regulator Output ByM

- setpAX1:

    Variable SetpAx[1] define the setpoint of the servo loop.

- setpAY1:

    Variable SetpAy[1] define the setpoint of the servo loop.

- sumA1:

    Sum signal of angle detector ‘A’

- sumB1:

    Sum signal of position detector ‘B’

- aX1:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY1:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX1:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY1:

    Variable By represents the measured position deviation in y direction from zero position

- rAX1:

    Regulator Output Ax

- rAY1:

    Regulator Output Ay

- rBX1:

    Regulator Output Bx

- rBY1:

    Regulator Output By

- rAXM1:

    Regulator Output AxM

- rAYM1:

    Regulator Output AyM

- rBXM1:

    Regulator Output BxM

- rBYM1:

    Regulator Output ByM

- stage1Id:

    Karabo device ID of first grating motor

- stage2Id:

    Karabo device ID of first grating motor

- tunnel:

    Location where doocs_device is deployed (e.g. ‘SASE1’)

- labx2MName:

    DOOCS name of X2 Master doocs_device

- labx2SName:

    DOOCS name of X2 Slave doocs_device

- timingShifterName:

    DOOCS name of Phase Shifter doocs_device

- manualTuning:

    Manual Tuning Enable

- useShifter:

    Set to True if optical synchronization is available

- midTsValue:

    Mid Value of Phase Shifter

- maxTsDelay:

    Maximum delay to add/subtract to phase shifter position

- maxTsJitter:

    Maximum allowed jitter

- laserOpModeList:

    Select Laser Op Mode

- activeLaserOpMode:

    Active Op laser Mode

- laserOpModeListApply:

    Apply Laser Operation Mode

- dmBCCAuto:

    Automatic loop on/off

- pCellState:

    Status of Pockels Cell, True = On

- pCellOn:

    Set Pockels cell on

- pCellOff:

    Set Pockels cell off

- AOMState:

    Status of AOM, True = On

- AOMOn:

    Set AOM on

- AOMOff:

    Set AOM off

- maxAllowedPcPhase:

    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

- mPCCLKPhase:

    Master PC Phase

- mSWPCCLKPhase:

    Master SW PC Phase

- mBurstWidth:

    Master burst width [us]

- mBurstWidthApply:

    Apply m Burst Width

- mBurstStart:

    Begining of the bursts the slave burst is +50ms)

- mBurstStartsms:

    Master burst starts pos. [us]

- sBurstStartsms:

    Sleve burst starts pos. [us]

- smBurstDiff:

    Different between muster and slave burst positione

- sPCCLKPhase:

    Master PC Phase

- sSWPCCLKPhase:

    Slave software PC PHase

- sBurstWidth:

    Slave burst width [us]

- sBurstWidthApply:

    Apply S Burst width

- delayBPMaster:

    Current delay of the master bunch pattern in clock unit (machine)

- delayBPMasterP:

    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterM:

    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterP24:

    Increment Master Bunch Pattern delay by 24 clock unit

- delayBPMasterM24:

    Decrement Master Bunch Pattern delay by 24 clock unit

- delayBPSlave:

    Current delay of the slave bunch pattern in clock unit (machine)

- delayBPSlaveP:

    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveM:

    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveP24:

    Increment Slave Bunch Pattern delay by 24 clock unit

- delayBPSlaveM24:

    Decrement Slave Bunch Pattern delay by 24 clock unit

- masterExpPattern:

    Select pattern for master experiment

- slaveExpPattern:

    Select pattern for slave experiment

- currentLaserPatterns:

    Current Laser Patterns

- currentMasterLaserPattern:

    Current Master Laser Patterns

- currentSlaveLaserPattern:

    Current Slave Laser Patterns

- currentSlaveLaserPatternN:

    Current Slave Laser Pattern

- fineDelayMaxCounts:

    Fine delay - maximum count number

- fineDelayValue:

    fine delay count value

- fineDelayValueT:

    fine delay time value

- fineDelayP:

    Increment fine delay

- fineDelayM:

    Decrement fine delay

- fineDelay9nsChange:

    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

- fineDelay9ns:

    Change Fine Delay by 9 ns

- minTsPosition:

    Minimum Timing Shifter Delay

- maxTsPosition:

    Maximum Timing Shifter Delay

- currentTsPosition:

    current value of time shifter position

- requestedTsDelay:

    Delay to apply to the phase shifter

- DelayTsChange:

    Change phase shifter by requested value

- relAbsolutTsPos:

    True for relative, False for absolute

- stopPsChange:

    Abort phase shift change

- opticalSynch:

    Display status of optical synchronization

- opticalSynchLock:

    Display lock status of optical synchronization

- opticalSynchJitter:

    Display status of optical synchronization jitter

- opticalSynchMode:

    Optical synch. mode (RF / Optical)

- setOpticalDelay:

    Delay to apply to optical delay line

- applyOpticalDelay:

    change the optical delay by requeste value

- currentOpticalDelay:

    Current position of optical delay

- relAbsolutDelayLine:

    True for relative, False for absolute

- TsJitter:

    Optical Synchronization Jitter

- triggerFE_DOWNSTREAM:

    Current trigger delay FE DOWNSTREAM

- triggerFE_UPSTREAM:

    Current trigger delay FE UPSTREAM

- getCurrentHardwareStatus:

    Read configuration from hardware

- lastShiftDelay:

    FE delay value from the prevoius shift

- setLastShiftDelay:

    Bring the delay to position from the previus shift

- clearLock:

    In case of STATE == changing bring the state to Normal

- mPCCLKPhaseSetValue:

    Master PC CLK Phase Value

- sPCCLKPhaseSetValue:

    Slave PC CLK Phase Value

- delayBPMasterSetValue:

    Master BP delay Value

- delayBPSlaveSetValue:

    Slave BP delay Value

- resetError:

    Reset error state

- upstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for upstream instrument

- downstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for downstream instrument

- shiftChange:

    Swaps MASTER and SLAVE properties between upstream and downstream instrument

- isOxcActive:

    Status of optical lock (True: OPTICAL mode, False: RF mode)

- requestedDelay:

    Relative delay to be applied by delay change (Trigger Position)

- delayChange:

    Change delay value by applying (relative) offset

- mPCCLKPhaseP:

    Increment PC master Phase

- mPCCLKPhaseM:

    Decrement PC master Phase

- sPCCLKPhaseP:

    Increment slave PC Phase

- sPCCLKPhaseM:

    Decrement slave PC phase

- savemSWPCCLKPhase:

    Save new software phase value for PCm

- savesSWPCCLKPhase:

    Save new software phase value for PCs

- mBurstStartApply:

    Apply Burst Start Pos

- takemidTsValue:

    Take mid value of phase shifter

- logBoardsStatus:

    JSON string describing master and slave board settings.Usually updated when user actions are taken

- logFineDelay:

    JSON string describing fine delay settings.Usually updated when user actions are taken

- imgprocDevice:

    Device ID of image processor used for feedback

- temDevice:

    id of tem device

- temChannel:

    TEM channel to be controlled

- xCoefWeight:

    weight of X coefficient

- yCoefWeight:

    weight of Y coefficient

- axCoefOld:

    Value of Ax Coefficient saved prior to calibration

- ayCoefOld:

    Value of Ay Coefficient saved prior to calibration

- xBeamCenterTarget:

    desired value for Beam Center X coordinate

- yBeamCenterTarget:

    desired value for Beam Center Y coordinate

- beamCenterMaxDisplacement:

    maximum allowed displacement for Center of Mass from target position

- maxTemDrift:

    Maximum value allowed for TEM drift

- averageNumber:

    number of values of beam center coordinates to average

- timeoutImageProcessorValues:

    Time to wait before going in error when values from image processor are not updating

- imageSettlementTime:

    Time to wait before reading beam center coordinates aftermoving TEM setpoint

- calibrationStep:

    TEM setpoint step size for calibration

- calibrationStepsNumber:

    Number of TEM calibration steps

- maxTimeNotRegulating:

    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

- setCurrentPosAsTarget:

    Set current beam position as target

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

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

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

###### GUIDELASER_FXE_LD_REM

Instance id: | LA1_LAS_PPL/DCTRL/GUIDELASER_FXE_LD_REM
Host: | exflcon14n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

Device Schema Description

- _serverId_:

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

- _deviceId_:

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

- _connection_:

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

- visibility:

    Configures who is allowed to see this device at all

- deviceId:

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

- classId:

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

- classVersion:

    The version of the class of this device defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- alarmCondition:

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

- lastCommand:

    The last slot called.

- archive:

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

- useTimeserver:

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

- progress:

    The progress of the current action

- heartbeatInterval:

    The heartbeat interval

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

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

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

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

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

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

- epsilon:

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

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

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

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

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

- maxStateUpdateRate:

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

- noisyStateUpdateRateValue:

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

- isStateUpdateNoisy:

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

- reset:

    Resets the PLC hardware

- enableInterlockedSlots:

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

- disableInterlockedSlots:

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

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

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

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

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

- readHardware:

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

- force:

    ???

- trigger:

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

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- value:

    Analog input of ADC.

- scale:

    Scaling factor for analog value.

- offset:

    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!

- start:

    Instructs device to go to started state

- stop:

    Instructs device to go to stopped state

- resetADC:

    Reset ADC’s of FPGA in case of constant line, No signal

- resetDDR2:

    Resets DDR2 in case of constant line, No signal

- deviceFile:

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

- mapDirectory:

    Folder where all xml mapping files are located.

- numberRawSamples:

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

- delay:

    Delay between calibration images.

- skipSamples:

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

- triggerTime:

    Time between Triggers

- triggerTimeStat:

    Histogram of time between Triggers

- trainId:

    Current train ID as read from the FPGA

- config:

    Board related configuration parameters.

- dacNode:

    Set up DAC parameters

- channel_0:

    This is a channel of bunch of other parameters

- channel_1:

    This is a channel of bunch of other parameters

- channel_2:

    This is a channel of bunch of other parameters

- channel_3:

    This is a channel of bunch of other parameters

- channel_4:

    This is a channel of bunch of other parameters

- channel_5:

    This is a channel of bunch of other parameters

- channel_6:

    This is a channel of bunch of other parameters

- channel_7:

    This is a channel of bunch of other parameters

- channel_8:

    This is a channel of bunch of other parameters

- channel_9:

    This is a channel of bunch of other parameters

- semiRawValue:

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

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- timeServerId:

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

- Logger:

    Logging settings

- sendCommand:

    Send command to the instrument.

- replyToCommand:

    Reply to the command send to the instrument.

- gotoErrorOnPollFailure:

    Instrument will go to error if poll fails for all properties.

- autoConnect:

    Set True to automatically connect to device.

- pollingInterval:

    The interval for polling the instrument.

- enableHeartbeat:

    Enable Heartbeat

- heartbeatCommand:

    Text to send as heartbeat

- heartbeatReply:

    Heartbeat reply text

- heartbeatPeriod:

    Heartbeat period

- heartbeatTime:

    Last heartbeat time

- pollingTimeTaken:

    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

- pollNow:

    Poll instrument now!

- _connect_:

    Connects to the device

- disconnect:

    Disconnects from the device

- handshake:

    Set the state of the message roundtrip handshaking.

- baudRate:

    Set the transmit and receive baud rates on the RS-232 port.

- errorCount:

    The number of error records in the queue.

- measureType:

    Set the meter measurement mode (energy or power).

- statisticsMode:

    Set the statistics processing mode (on or off).

- variableDecimation:

    Set the pulse decimation rate (1-99999).

- apertureDiameter:

    Set the aperture diameter.

- wavelength:

    Set the current wavelength.

- gainCompensation:

    Enables or disables the gain compensation.

- gainFactor:

    Set the gain compensation factor.

- range:

    Set the measurement range (maximum expected measurement).

- batchSize:

    Set the statistics batch size.

- restartMode:

    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

- statStart:

    Terminates the current statistical batch and start a new one.

- statStop:

    Terminates the current statistical batch.

- triggerSource:

    Selects the trigger source (INTernal / EXTernal).

- triggerLevel:

    Set the trigger level (no effect when external trigger is selected).

- triggerSlope:

    Selects the external trigger edge (POSitive / NEGative).

- sequenceId:

    Set the sequence ID.

- triggerBus:

    Selects the trigger bus participation mode.

- itemSelect:

    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

- statItemSelect:

    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

- serialNumber:

    The serial number string.

- partNumber:

    The part number.

- modelName:

    The Model Name.

- calibrationDate:

    The calibration date.

- manifacturingDate:

    The manifacturing date.

- defaultWavelength:

    The default wavelength.

- measurementRefreshRate:

    The refresh rate of measurements.

- measurement:

    Last measurement.

- idType:

    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

- cameraId:

    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

- packetDelay:

    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

- autoPacketSize:

    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

- packetSize:

    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

- exposureTime:

    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

- triggerMode:

    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

- triggerActivation:

    This enumeration sets the signal transition needed to activate the selected trigger.

- autoGain:

    Configures automatic gain feature.

- gain:

    Sets the gain of the ADC converter.

- acquisitionMode:

    This property sets the image acquisition mode.

- frameCount:

    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

- xPeak1:

    x-position of peak in first calibration image.

- xFWHM1:

    x-FWHM in first calibration image.

- xPeak2:

    x-position of peak in second calibration image.

- xFWHM2:

    x-FWHM in second calibration image.

- delayUnit:

    Unit of the delay between calibration images.

- useAsCalibrationImage1:

    Use the current image as 1st calibration image.

- useAsCalibrationImage2:

    Use the current image as 2nd calibration image.

- calibrate:

  > perform calibrationStepsNumber steps of calibrationStep size starting and ending in symmetrical places relatively to initial position, both along X and Y, while measuring center of beam position.

  > Use these measurements to calculate axCoef and ayCoef.

  > Assumptions that are made: sin(x) ~= x x(y) axis of TEM parallel to x (y) axis of camera

- calibrationFactor:

    The calibration constant.

- beamShape:

    Time shape of the beam.

- xMinFit:

    Lower limit for the fit.

- xMaxFit:

    Upper limit for the fit.

- fitStatus:

    Error of fit procedure: 1-3 means good fit. See device documentation for further details.

- subtractPedestal:

    Subtract the pedestal, calculated from linear interpolation between first and last point.

- xPeak3:

    x-position of peak in the input image.

- xFWHM3:

    x-FWHM in the input image.

- pulseWidth:

    Duration of the pulse.

- ePulseWidth:

    Uncertainty of the pulse duration arising from fit procedure.

- switchToReady:

    Instructs the amplifier to go to ready state.

- switchOn:

    Instructs the amplifier to go to on state.

- switchOff:

    Instructs the amplifier to go to off state.

- closeShutter2:

    Instructs the amplifier to close Shutter 2.

- openShutter2:

    Instructs the amplifier to open Shutter 2.

- amphosIp:

    The IP address of the Amphos Control.

- amphosPort:

    The port of the Amphos Control.

- stateChanging:

    Laser is currently changing state.

- targetPower:

    Target laser power.

- chillerTemperature:

    Measured temperature of chiller.

- chillerFlow:

    Measured flow of chiller [l/min].

- chillerValvePosition:

    Measured valve position.

- shutter2IsOpen:

    Shutter2 State: False=closed True=open

- lambdaIsBusy:

    Lambda plate is moving.

- laserCurrent:

    Measured current of Amphos400.

- laserTemperature:

    Measured temperature of Amphos400.

- laserHumidity:

    Measured humidity of Amphos400.

- xfelCurrentCW1:

    Measured current of XFEL booster 1 (CW1).

- xfelCurrentCW2:

    Measured current of XFEL booster 1 (CW2).

- xfelCurrentQCW1:

    Measured current of XFEL booster 1 (QCW1).

- xfelCurrentQCW2:

    Measured current of XFEL booster 1 (QCW2).

- xfelCurrentQCW3:

    Measured current of XFEL booster 1 (QCW3).

- xfelCurrentQCW4:

    Measured current of XFEL booster 1 (QCW3).

- xfelTemperature:

    Measured temperature of XFEL booster 1.

- xfelHumidity:

    Measured humidity of XFEL booster 1.

- globalAlarmCondition:

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

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- log:

    Logging settings

- adc:

    fast ADC input device

- selectedAdcChannel:

    fast ADC channel in use for the loop

- maxPeakValue:

    Max absolute value for ADC peak. When peak is above this value step is applied

- tuneStage:

    motor controlling the stage to adjust laser path

- stageStep:

    value of stage tuning step size

- loopPeriod:

    Time interval for feedback cycle

- doublecheckWaitTime:

    after peak is above max, this time is waiting to check itagain, before applying step

- calibStepSize:

    Size of calibration step

- calibStepNum:

    Number of calibration steps

- calibAverageNum:

    number of peak values to be averaged for each calibration step

- reverseDirection:

    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

- conversionFactor:

    micrometers to femtoseconds conversion factor

- adcValueTimeout:

    if ADC value is not updated within this time, device goesin error state

- amphosAmpli:

    Karabo ID of Amphos Laser Amplifier

- triggerDelayDevice:

    Karabo ID of pplDelayControl device, used to read Pockels cell status

- moveToPlus:

    Move to +x position

- moveToMinus:

    Move to -x position

- moveToZero:

    Move to 0 position

- pathToProgramFiles:

    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

- correctionFile:

    The correction (.ct5) file, including path.

- useExternalTrigger:

    Use external trigger (if true) or auto-run (if false).

- startFromMinusX:

    Set loop initial position to -X

- jumpSpeed:

    The up/down jump speed [bits/ms].

- jumpAmplitude:

    The up/down jump amplitude [bits].

- delayTimePlus:

    Delay time, after moving to position +x.

- delayTimeMinus:

    Delay time, after moving to position -x.

- onTargetTolerance:

    The tolerance [bits] when checking that Galvo is on target position.

- onTargetPlus:

    Galvo is currently at +x position _and_ not moving.

- onTargetMinus:

    Galvo is currently at -x position _and_ not moving.

- laserOn:

    The value of the LASERON signal.

- digitalOut1:

    The value of the DIGITAL OUT1 signal.

- stopEventCode:

    Stop event code.

- galvoTemperature:

    Galvanometer scanner temperature.

- servoTemperature:

    Servo board temperature.

- agcVoltage:

    AGC voltage (PD supply voltage).

- dspCoreVoltage:

    DSP core supply voltage (1.8 V).

- dspIoVoltage:

    DSP IO voltage (3.3 V).

- analogSectVoltage:

    Analog section voltage (9 V).

- adConverterVoltage:

    AD converter supply voltage (5 V).

- galvoHeatingOut:

    Relative heating output of the corresponding galvanometer scanner heater.

- beamline:

    Beamline where to operate

- timingDevice:

    Device ID of PPL Delay Control Device

- galvoDevice:

    id of Galvo Controller

- downstreamSpectr1Device:

    Spectrometer 1 (FXE/SCS)

- upstreamSpectr1Device:

    Spectrometer 1 (SPB/SQS)

- currentExperiment:

    Current MASTER experiment (UPSTREAM or DOWNSTREAM)

- currentVersion:

    Current version

- correctionFactorMaster:

    Correction Factor Master

- correctionFactorSlave:

    Correction Factor Slave

- switchProgress:

    Switching Progress

- switchExperiment:

    Procedure to automatically swap between FXE and SPB delay control and Galvo settings

- on:

    Instructs the device to switch on

- off:

    Instructs device to switch off

- lastError:

    Last error message received. Time is set by front-end firmware.

- scpiTimeout:

    The SCPI communication timeout.

- baseFreq:

    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

- frontendReset:

    send reset command

- s7ack:

    acknowledge to s7 command

- s8ack:

    acknowledge to s8 command

- s9ack:

    acknowledge to s9 command

- laserEmission:

    True when laser ON, false when OFF

- generalStatus:

    True = OK, False = not OK

- temperatureStatus:

    True = OK, False = not OK

- delayBoardStatus:

    True = OK, False = not OK

- inputPin0Status:

    True = OK, False = not OK

- inputPin4Status:

    True = OK, False = not OK

- pd1Voltage:

    Photodiode 1 (TAB 2) voltage

- pd1VoltageAverage:

    Averaged PD1 (TAB 2) voltage

- pd2Voltage:

    Photodiode 2 (TAB 5) voltage

- pd2VoltageAverage:

    Averaged PD2 (TAB 5) voltage

- pd3Voltage:

    PD3 (SPCO 1) voltage

- pd3VoltageAverage:

    Averaged PD3 (SPCO 1) voltage

- pd4Voltage:

    PD4 (TAB 7) voltage

- pd4VoltageAverage:

    Averaged PD4 (TAB 7) voltage

- pd5Voltage:

    PD5 (SPCO2) voltage

- pd5VoltageAverage:

    Averaged PD5 (SPCO2) voltage

- pd6Voltage:

    PD6 voltage

- pd6VoltageAverage:

    Averaged PD6 voltage

- pd7Voltage:

    PD7 voltage

- pd7VoltageAverage:

    Averaged PD7 voltage

- pd8Voltage:

    PD8 voltage

- pd8VoltageAverage:

    Averaged PD8 voltage

- seederOutPower:

    photodiode 1

- xf1OutPower:

    Photodiode 7

- xf2OutPower:

    Photodiode 8

- seederStatus:

    True = OK, False = not OK

- generalSeederStatus:

    True = OK, False = not OK

- hiltiErrorStatus:

    True = OK, False = not OK

- remoteControl:

    if it is false we cannot see it

- regOnOff0:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- regOnOff1:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- setpAX0:

    Variable SetpAx[0] define the setpoint of the servo loop.

- setpAY0:

    Variable SetpAy[0] define the setpoint of the servo loop.

- sumA0:

    Sum signal of angle detector ‘A’

- sumB0:

    Sum signal of position detector ‘B’

- aX0:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY0:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX0:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY0:

    Variable By represents the measured position deviation in y direction from zero position

- rAX0:

    Regulator Output Ax

- rAY0:

    Regulator Output Ay

- rBX0:

    Regulator Output Bx

- rBY0:

    Regulator Output By

- rAXM0:

    Regulator Output AxM

- rAYM0:

    Regulator Output AyM

- rBXM0:

    Regulator Output BxM

- rBYM0:

    Regulator Output ByM

- setpAX1:

    Variable SetpAx[1] define the setpoint of the servo loop.

- setpAY1:

    Variable SetpAy[1] define the setpoint of the servo loop.

- sumA1:

    Sum signal of angle detector ‘A’

- sumB1:

    Sum signal of position detector ‘B’

- aX1:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY1:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX1:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY1:

    Variable By represents the measured position deviation in y direction from zero position

- rAX1:

    Regulator Output Ax

- rAY1:

    Regulator Output Ay

- rBX1:

    Regulator Output Bx

- rBY1:

    Regulator Output By

- rAXM1:

    Regulator Output AxM

- rAYM1:

    Regulator Output AyM

- rBXM1:

    Regulator Output BxM

- rBYM1:

    Regulator Output ByM

- stage1Id:

    Karabo device ID of first grating motor

- stage2Id:

    Karabo device ID of first grating motor

- tunnel:

    Location where doocs_device is deployed (e.g. ‘SASE1’)

- labx2MName:

    DOOCS name of X2 Master doocs_device

- labx2SName:

    DOOCS name of X2 Slave doocs_device

- timingShifterName:

    DOOCS name of Phase Shifter doocs_device

- manualTuning:

    Manual Tuning Enable

- useShifter:

    Set to True if optical synchronization is available

- midTsValue:

    Mid Value of Phase Shifter

- maxTsDelay:

    Maximum delay to add/subtract to phase shifter position

- maxTsJitter:

    Maximum allowed jitter

- laserOpModeList:

    Select Laser Op Mode

- activeLaserOpMode:

    Active Op laser Mode

- laserOpModeListApply:

    Apply Laser Operation Mode

- dmBCCAuto:

    Automatic loop on/off

- pCellState:

    Status of Pockels Cell, True = On

- pCellOn:

    Set Pockels cell on

- pCellOff:

    Set Pockels cell off

- AOMState:

    Status of AOM, True = On

- AOMOn:

    Set AOM on

- AOMOff:

    Set AOM off

- maxAllowedPcPhase:

    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

- mPCCLKPhase:

    Master PC Phase

- mSWPCCLKPhase:

    Master SW PC Phase

- mBurstWidth:

    Master burst width [us]

- mBurstWidthApply:

    Apply m Burst Width

- mBurstStart:

    Begining of the bursts the slave burst is +50ms)

- mBurstStartsms:

    Master burst starts pos. [us]

- sBurstStartsms:

    Sleve burst starts pos. [us]

- smBurstDiff:

    Different between muster and slave burst positione

- sPCCLKPhase:

    Master PC Phase

- sSWPCCLKPhase:

    Slave software PC PHase

- sBurstWidth:

    Slave burst width [us]

- sBurstWidthApply:

    Apply S Burst width

- delayBPMaster:

    Current delay of the master bunch pattern in clock unit (machine)

- delayBPMasterP:

    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterM:

    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterP24:

    Increment Master Bunch Pattern delay by 24 clock unit

- delayBPMasterM24:

    Decrement Master Bunch Pattern delay by 24 clock unit

- delayBPSlave:

    Current delay of the slave bunch pattern in clock unit (machine)

- delayBPSlaveP:

    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveM:

    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveP24:

    Increment Slave Bunch Pattern delay by 24 clock unit

- delayBPSlaveM24:

    Decrement Slave Bunch Pattern delay by 24 clock unit

- masterExpPattern:

    Select pattern for master experiment

- slaveExpPattern:

    Select pattern for slave experiment

- currentLaserPatterns:

    Current Laser Patterns

- currentMasterLaserPattern:

    Current Master Laser Patterns

- currentSlaveLaserPattern:

    Current Slave Laser Patterns

- currentSlaveLaserPatternN:

    Current Slave Laser Pattern

- fineDelayMaxCounts:

    Fine delay - maximum count number

- fineDelayValue:

    fine delay count value

- fineDelayValueT:

    fine delay time value

- fineDelayP:

    Increment fine delay

- fineDelayM:

    Decrement fine delay

- fineDelay9nsChange:

    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

- fineDelay9ns:

    Change Fine Delay by 9 ns

- minTsPosition:

    Minimum Timing Shifter Delay

- maxTsPosition:

    Maximum Timing Shifter Delay

- currentTsPosition:

    current value of time shifter position

- requestedTsDelay:

    Delay to apply to the phase shifter

- DelayTsChange:

    Change phase shifter by requested value

- relAbsolutTsPos:

    True for relative, False for absolute

- stopPsChange:

    Abort phase shift change

- opticalSynch:

    Display status of optical synchronization

- opticalSynchLock:

    Display lock status of optical synchronization

- opticalSynchJitter:

    Display status of optical synchronization jitter

- opticalSynchMode:

    Optical synch. mode (RF / Optical)

- setOpticalDelay:

    Delay to apply to optical delay line

- applyOpticalDelay:

    change the optical delay by requeste value

- currentOpticalDelay:

    Current position of optical delay

- relAbsolutDelayLine:

    True for relative, False for absolute

- TsJitter:

    Optical Synchronization Jitter

- triggerFE_DOWNSTREAM:

    Current trigger delay FE DOWNSTREAM

- triggerFE_UPSTREAM:

    Current trigger delay FE UPSTREAM

- getCurrentHardwareStatus:

    Read configuration from hardware

- lastShiftDelay:

    FE delay value from the prevoius shift

- setLastShiftDelay:

    Bring the delay to position from the previus shift

- clearLock:

    In case of STATE == changing bring the state to Normal

- mPCCLKPhaseSetValue:

    Master PC CLK Phase Value

- sPCCLKPhaseSetValue:

    Slave PC CLK Phase Value

- delayBPMasterSetValue:

    Master BP delay Value

- delayBPSlaveSetValue:

    Slave BP delay Value

- resetError:

    Reset error state

- upstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for upstream instrument

- downstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for downstream instrument

- shiftChange:

    Swaps MASTER and SLAVE properties between upstream and downstream instrument

- isOxcActive:

    Status of optical lock (True: OPTICAL mode, False: RF mode)

- requestedDelay:

    Relative delay to be applied by delay change (Trigger Position)

- delayChange:

    Change delay value by applying (relative) offset

- mPCCLKPhaseP:

    Increment PC master Phase

- mPCCLKPhaseM:

    Decrement PC master Phase

- sPCCLKPhaseP:

    Increment slave PC Phase

- sPCCLKPhaseM:

    Decrement slave PC phase

- savemSWPCCLKPhase:

    Save new software phase value for PCm

- savesSWPCCLKPhase:

    Save new software phase value for PCs

- mBurstStartApply:

    Apply Burst Start Pos

- takemidTsValue:

    Take mid value of phase shifter

- logBoardsStatus:

    JSON string describing master and slave board settings.Usually updated when user actions are taken

- logFineDelay:

    JSON string describing fine delay settings.Usually updated when user actions are taken

- imgprocDevice:

    Device ID of image processor used for feedback

- temDevice:

    id of tem device

- temChannel:

    TEM channel to be controlled

- xCoefWeight:

    weight of X coefficient

- yCoefWeight:

    weight of Y coefficient

- axCoefOld:

    Value of Ax Coefficient saved prior to calibration

- ayCoefOld:

    Value of Ay Coefficient saved prior to calibration

- xBeamCenterTarget:

    desired value for Beam Center X coordinate

- yBeamCenterTarget:

    desired value for Beam Center Y coordinate

- beamCenterMaxDisplacement:

    maximum allowed displacement for Center of Mass from target position

- maxTemDrift:

    Maximum value allowed for TEM drift

- averageNumber:

    number of values of beam center coordinates to average

- timeoutImageProcessorValues:

    Time to wait before going in error when values from image processor are not updating

- imageSettlementTime:

    Time to wait before reading beam center coordinates aftermoving TEM setpoint

- calibrationStep:

    TEM setpoint step size for calibration

- calibrationStepsNumber:

    Number of TEM calibration steps

- maxTimeNotRegulating:

    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

- setCurrentPosAsTarget:

    Set current beam position as target

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

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

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

###### GUIDELASER_SPB_LD_REM

Instance id: | LA1_LAS_PPL/DCTRL/GUIDELASER_SPB_LD_REM
Host: | exflcon14n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

Device Schema Description

- _serverId_:

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

- _deviceId_:

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

- _connection_:

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

- visibility:

    Configures who is allowed to see this device at all

- deviceId:

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

- classId:

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

- classVersion:

    The version of the class of this device defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- alarmCondition:

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

- lastCommand:

    The last slot called.

- archive:

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

- useTimeserver:

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

- progress:

    The progress of the current action

- heartbeatInterval:

    The heartbeat interval

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

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

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

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

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

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

- epsilon:

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

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

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

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

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

- maxStateUpdateRate:

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

- noisyStateUpdateRateValue:

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

- isStateUpdateNoisy:

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

- reset:

    Resets the PLC hardware

- enableInterlockedSlots:

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

- disableInterlockedSlots:

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

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

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

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

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

- readHardware:

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

- force:

    ???

- trigger:

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

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- value:

    Analog input of ADC.

- scale:

    Scaling factor for analog value.

- offset:

    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!

- start:

    Instructs device to go to started state

- stop:

    Instructs device to go to stopped state

- resetADC:

    Reset ADC’s of FPGA in case of constant line, No signal

- resetDDR2:

    Resets DDR2 in case of constant line, No signal

- deviceFile:

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

- mapDirectory:

    Folder where all xml mapping files are located.

- numberRawSamples:

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

- delay:

    Delay between calibration images.

- skipSamples:

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

- triggerTime:

    Time between Triggers

- triggerTimeStat:

    Histogram of time between Triggers

- trainId:

    Current train ID as read from the FPGA

- config:

    Board related configuration parameters.

- dacNode:

    Set up DAC parameters

- channel_0:

    This is a channel of bunch of other parameters

- channel_1:

    This is a channel of bunch of other parameters

- channel_2:

    This is a channel of bunch of other parameters

- channel_3:

    This is a channel of bunch of other parameters

- channel_4:

    This is a channel of bunch of other parameters

- channel_5:

    This is a channel of bunch of other parameters

- channel_6:

    This is a channel of bunch of other parameters

- channel_7:

    This is a channel of bunch of other parameters

- channel_8:

    This is a channel of bunch of other parameters

- channel_9:

    This is a channel of bunch of other parameters

- semiRawValue:

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

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- timeServerId:

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

- Logger:

    Logging settings

- sendCommand:

    Send command to the instrument.

- replyToCommand:

    Reply to the command send to the instrument.

- gotoErrorOnPollFailure:

    Instrument will go to error if poll fails for all properties.

- autoConnect:

    Set True to automatically connect to device.

- pollingInterval:

    The interval for polling the instrument.

- enableHeartbeat:

    Enable Heartbeat

- heartbeatCommand:

    Text to send as heartbeat

- heartbeatReply:

    Heartbeat reply text

- heartbeatPeriod:

    Heartbeat period

- heartbeatTime:

    Last heartbeat time

- pollingTimeTaken:

    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

- pollNow:

    Poll instrument now!

- _connect_:

    Connects to the device

- disconnect:

    Disconnects from the device

- handshake:

    Set the state of the message roundtrip handshaking.

- baudRate:

    Set the transmit and receive baud rates on the RS-232 port.

- errorCount:

    The number of error records in the queue.

- measureType:

    Set the meter measurement mode (energy or power).

- statisticsMode:

    Set the statistics processing mode (on or off).

- variableDecimation:

    Set the pulse decimation rate (1-99999).

- apertureDiameter:

    Set the aperture diameter.

- wavelength:

    Set the current wavelength.

- gainCompensation:

    Enables or disables the gain compensation.

- gainFactor:

    Set the gain compensation factor.

- range:

    Set the measurement range (maximum expected measurement).

- batchSize:

    Set the statistics batch size.

- restartMode:

    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

- statStart:

    Terminates the current statistical batch and start a new one.

- statStop:

    Terminates the current statistical batch.

- triggerSource:

    Selects the trigger source (INTernal / EXTernal).

- triggerLevel:

    Set the trigger level (no effect when external trigger is selected).

- triggerSlope:

    Selects the external trigger edge (POSitive / NEGative).

- sequenceId:

    Set the sequence ID.

- triggerBus:

    Selects the trigger bus participation mode.

- itemSelect:

    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

- statItemSelect:

    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

- serialNumber:

    The serial number string.

- partNumber:

    The part number.

- modelName:

    The Model Name.

- calibrationDate:

    The calibration date.

- manifacturingDate:

    The manifacturing date.

- defaultWavelength:

    The default wavelength.

- measurementRefreshRate:

    The refresh rate of measurements.

- measurement:

    Last measurement.

- idType:

    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

- cameraId:

    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

- packetDelay:

    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

- autoPacketSize:

    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

- packetSize:

    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

- exposureTime:

    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

- triggerMode:

    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

- triggerActivation:

    This enumeration sets the signal transition needed to activate the selected trigger.

- autoGain:

    Configures automatic gain feature.

- gain:

    Sets the gain of the ADC converter.

- acquisitionMode:

    This property sets the image acquisition mode.

- frameCount:

    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

- xPeak1:

    x-position of peak in first calibration image.

- xFWHM1:

    x-FWHM in first calibration image.

- xPeak2:

    x-position of peak in second calibration image.

- xFWHM2:

    x-FWHM in second calibration image.

- delayUnit:

    Unit of the delay between calibration images.

- useAsCalibrationImage1:

    Use the current image as 1st calibration image.

- useAsCalibrationImage2:

    Use the current image as 2nd calibration image.

- calibrate:

  > perform calibrationStepsNumber steps of calibrationStep size starting and ending in symmetrical places relatively to initial position, both along X and Y, while measuring center of beam position.

  > Use these measurements to calculate axCoef and ayCoef.

  > Assumptions that are made: sin(x) ~= x x(y) axis of TEM parallel to x (y) axis of camera

- calibrationFactor:

    The calibration constant.

- beamShape:

    Time shape of the beam.

- xMinFit:

    Lower limit for the fit.

- xMaxFit:

    Upper limit for the fit.

- fitStatus:

    Error of fit procedure: 1-3 means good fit. See device documentation for further details.

- subtractPedestal:

    Subtract the pedestal, calculated from linear interpolation between first and last point.

- xPeak3:

    x-position of peak in the input image.

- xFWHM3:

    x-FWHM in the input image.

- pulseWidth:

    Duration of the pulse.

- ePulseWidth:

    Uncertainty of the pulse duration arising from fit procedure.

- switchToReady:

    Instructs the amplifier to go to ready state.

- switchOn:

    Instructs the amplifier to go to on state.

- switchOff:

    Instructs the amplifier to go to off state.

- closeShutter2:

    Instructs the amplifier to close Shutter 2.

- openShutter2:

    Instructs the amplifier to open Shutter 2.

- amphosIp:

    The IP address of the Amphos Control.

- amphosPort:

    The port of the Amphos Control.

- stateChanging:

    Laser is currently changing state.

- targetPower:

    Target laser power.

- chillerTemperature:

    Measured temperature of chiller.

- chillerFlow:

    Measured flow of chiller [l/min].

- chillerValvePosition:

    Measured valve position.

- shutter2IsOpen:

    Shutter2 State: False=closed True=open

- lambdaIsBusy:

    Lambda plate is moving.

- laserCurrent:

    Measured current of Amphos400.

- laserTemperature:

    Measured temperature of Amphos400.

- laserHumidity:

    Measured humidity of Amphos400.

- xfelCurrentCW1:

    Measured current of XFEL booster 1 (CW1).

- xfelCurrentCW2:

    Measured current of XFEL booster 1 (CW2).

- xfelCurrentQCW1:

    Measured current of XFEL booster 1 (QCW1).

- xfelCurrentQCW2:

    Measured current of XFEL booster 1 (QCW2).

- xfelCurrentQCW3:

    Measured current of XFEL booster 1 (QCW3).

- xfelCurrentQCW4:

    Measured current of XFEL booster 1 (QCW3).

- xfelTemperature:

    Measured temperature of XFEL booster 1.

- xfelHumidity:

    Measured humidity of XFEL booster 1.

- globalAlarmCondition:

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

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- log:

    Logging settings

- adc:

    fast ADC input device

- selectedAdcChannel:

    fast ADC channel in use for the loop

- maxPeakValue:

    Max absolute value for ADC peak. When peak is above this value step is applied

- tuneStage:

    motor controlling the stage to adjust laser path

- stageStep:

    value of stage tuning step size

- loopPeriod:

    Time interval for feedback cycle

- doublecheckWaitTime:

    after peak is above max, this time is waiting to check itagain, before applying step

- calibStepSize:

    Size of calibration step

- calibStepNum:

    Number of calibration steps

- calibAverageNum:

    number of peak values to be averaged for each calibration step

- reverseDirection:

    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

- conversionFactor:

    micrometers to femtoseconds conversion factor

- adcValueTimeout:

    if ADC value is not updated within this time, device goesin error state

- amphosAmpli:

    Karabo ID of Amphos Laser Amplifier

- triggerDelayDevice:

    Karabo ID of pplDelayControl device, used to read Pockels cell status

- moveToPlus:

    Move to +x position

- moveToMinus:

    Move to -x position

- moveToZero:

    Move to 0 position

- pathToProgramFiles:

    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

- correctionFile:

    The correction (.ct5) file, including path.

- useExternalTrigger:

    Use external trigger (if true) or auto-run (if false).

- startFromMinusX:

    Set loop initial position to -X

- jumpSpeed:

    The up/down jump speed [bits/ms].

- jumpAmplitude:

    The up/down jump amplitude [bits].

- delayTimePlus:

    Delay time, after moving to position +x.

- delayTimeMinus:

    Delay time, after moving to position -x.

- onTargetTolerance:

    The tolerance [bits] when checking that Galvo is on target position.

- onTargetPlus:

    Galvo is currently at +x position _and_ not moving.

- onTargetMinus:

    Galvo is currently at -x position _and_ not moving.

- laserOn:

    The value of the LASERON signal.

- digitalOut1:

    The value of the DIGITAL OUT1 signal.

- stopEventCode:

    Stop event code.

- galvoTemperature:

    Galvanometer scanner temperature.

- servoTemperature:

    Servo board temperature.

- agcVoltage:

    AGC voltage (PD supply voltage).

- dspCoreVoltage:

    DSP core supply voltage (1.8 V).

- dspIoVoltage:

    DSP IO voltage (3.3 V).

- analogSectVoltage:

    Analog section voltage (9 V).

- adConverterVoltage:

    AD converter supply voltage (5 V).

- galvoHeatingOut:

    Relative heating output of the corresponding galvanometer scanner heater.

- beamline:

    Beamline where to operate

- timingDevice:

    Device ID of PPL Delay Control Device

- galvoDevice:

    id of Galvo Controller

- downstreamSpectr1Device:

    Spectrometer 1 (FXE/SCS)

- upstreamSpectr1Device:

    Spectrometer 1 (SPB/SQS)

- currentExperiment:

    Current MASTER experiment (UPSTREAM or DOWNSTREAM)

- currentVersion:

    Current version

- correctionFactorMaster:

    Correction Factor Master

- correctionFactorSlave:

    Correction Factor Slave

- switchProgress:

    Switching Progress

- switchExperiment:

    Procedure to automatically swap between FXE and SPB delay control and Galvo settings

- on:

    Instructs the device to switch on

- off:

    Instructs device to switch off

- lastError:

    Last error message received. Time is set by front-end firmware.

- scpiTimeout:

    The SCPI communication timeout.

- baseFreq:

    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

- frontendReset:

    send reset command

- s7ack:

    acknowledge to s7 command

- s8ack:

    acknowledge to s8 command

- s9ack:

    acknowledge to s9 command

- laserEmission:

    True when laser ON, false when OFF

- generalStatus:

    True = OK, False = not OK

- temperatureStatus:

    True = OK, False = not OK

- delayBoardStatus:

    True = OK, False = not OK

- inputPin0Status:

    True = OK, False = not OK

- inputPin4Status:

    True = OK, False = not OK

- pd1Voltage:

    Photodiode 1 (TAB 2) voltage

- pd1VoltageAverage:

    Averaged PD1 (TAB 2) voltage

- pd2Voltage:

    Photodiode 2 (TAB 5) voltage

- pd2VoltageAverage:

    Averaged PD2 (TAB 5) voltage

- pd3Voltage:

    PD3 (SPCO 1) voltage

- pd3VoltageAverage:

    Averaged PD3 (SPCO 1) voltage

- pd4Voltage:

    PD4 (TAB 7) voltage

- pd4VoltageAverage:

    Averaged PD4 (TAB 7) voltage

- pd5Voltage:

    PD5 (SPCO2) voltage

- pd5VoltageAverage:

    Averaged PD5 (SPCO2) voltage

- pd6Voltage:

    PD6 voltage

- pd6VoltageAverage:

    Averaged PD6 voltage

- pd7Voltage:

    PD7 voltage

- pd7VoltageAverage:

    Averaged PD7 voltage

- pd8Voltage:

    PD8 voltage

- pd8VoltageAverage:

    Averaged PD8 voltage

- seederOutPower:

    photodiode 1

- xf1OutPower:

    Photodiode 7

- xf2OutPower:

    Photodiode 8

- seederStatus:

    True = OK, False = not OK

- generalSeederStatus:

    True = OK, False = not OK

- hiltiErrorStatus:

    True = OK, False = not OK

- remoteControl:

    if it is false we cannot see it

- regOnOff0:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- regOnOff1:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- setpAX0:

    Variable SetpAx[0] define the setpoint of the servo loop.

- setpAY0:

    Variable SetpAy[0] define the setpoint of the servo loop.

- sumA0:

    Sum signal of angle detector ‘A’

- sumB0:

    Sum signal of position detector ‘B’

- aX0:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY0:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX0:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY0:

    Variable By represents the measured position deviation in y direction from zero position

- rAX0:

    Regulator Output Ax

- rAY0:

    Regulator Output Ay

- rBX0:

    Regulator Output Bx

- rBY0:

    Regulator Output By

- rAXM0:

    Regulator Output AxM

- rAYM0:

    Regulator Output AyM

- rBXM0:

    Regulator Output BxM

- rBYM0:

    Regulator Output ByM

- setpAX1:

    Variable SetpAx[1] define the setpoint of the servo loop.

- setpAY1:

    Variable SetpAy[1] define the setpoint of the servo loop.

- sumA1:

    Sum signal of angle detector ‘A’

- sumB1:

    Sum signal of position detector ‘B’

- aX1:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY1:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX1:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY1:

    Variable By represents the measured position deviation in y direction from zero position

- rAX1:

    Regulator Output Ax

- rAY1:

    Regulator Output Ay

- rBX1:

    Regulator Output Bx

- rBY1:

    Regulator Output By

- rAXM1:

    Regulator Output AxM

- rAYM1:

    Regulator Output AyM

- rBXM1:

    Regulator Output BxM

- rBYM1:

    Regulator Output ByM

- stage1Id:

    Karabo device ID of first grating motor

- stage2Id:

    Karabo device ID of first grating motor

- tunnel:

    Location where doocs_device is deployed (e.g. ‘SASE1’)

- labx2MName:

    DOOCS name of X2 Master doocs_device

- labx2SName:

    DOOCS name of X2 Slave doocs_device

- timingShifterName:

    DOOCS name of Phase Shifter doocs_device

- manualTuning:

    Manual Tuning Enable

- useShifter:

    Set to True if optical synchronization is available

- midTsValue:

    Mid Value of Phase Shifter

- maxTsDelay:

    Maximum delay to add/subtract to phase shifter position

- maxTsJitter:

    Maximum allowed jitter

- laserOpModeList:

    Select Laser Op Mode

- activeLaserOpMode:

    Active Op laser Mode

- laserOpModeListApply:

    Apply Laser Operation Mode

- dmBCCAuto:

    Automatic loop on/off

- pCellState:

    Status of Pockels Cell, True = On

- pCellOn:

    Set Pockels cell on

- pCellOff:

    Set Pockels cell off

- AOMState:

    Status of AOM, True = On

- AOMOn:

    Set AOM on

- AOMOff:

    Set AOM off

- maxAllowedPcPhase:

    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

- mPCCLKPhase:

    Master PC Phase

- mSWPCCLKPhase:

    Master SW PC Phase

- mBurstWidth:

    Master burst width [us]

- mBurstWidthApply:

    Apply m Burst Width

- mBurstStart:

    Begining of the bursts the slave burst is +50ms)

- mBurstStartsms:

    Master burst starts pos. [us]

- sBurstStartsms:

    Sleve burst starts pos. [us]

- smBurstDiff:

    Different between muster and slave burst positione

- sPCCLKPhase:

    Master PC Phase

- sSWPCCLKPhase:

    Slave software PC PHase

- sBurstWidth:

    Slave burst width [us]

- sBurstWidthApply:

    Apply S Burst width

- delayBPMaster:

    Current delay of the master bunch pattern in clock unit (machine)

- delayBPMasterP:

    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterM:

    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterP24:

    Increment Master Bunch Pattern delay by 24 clock unit

- delayBPMasterM24:

    Decrement Master Bunch Pattern delay by 24 clock unit

- delayBPSlave:

    Current delay of the slave bunch pattern in clock unit (machine)

- delayBPSlaveP:

    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveM:

    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveP24:

    Increment Slave Bunch Pattern delay by 24 clock unit

- delayBPSlaveM24:

    Decrement Slave Bunch Pattern delay by 24 clock unit

- masterExpPattern:

    Select pattern for master experiment

- slaveExpPattern:

    Select pattern for slave experiment

- currentLaserPatterns:

    Current Laser Patterns

- currentMasterLaserPattern:

    Current Master Laser Patterns

- currentSlaveLaserPattern:

    Current Slave Laser Patterns

- currentSlaveLaserPatternN:

    Current Slave Laser Pattern

- fineDelayMaxCounts:

    Fine delay - maximum count number

- fineDelayValue:

    fine delay count value

- fineDelayValueT:

    fine delay time value

- fineDelayP:

    Increment fine delay

- fineDelayM:

    Decrement fine delay

- fineDelay9nsChange:

    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

- fineDelay9ns:

    Change Fine Delay by 9 ns

- minTsPosition:

    Minimum Timing Shifter Delay

- maxTsPosition:

    Maximum Timing Shifter Delay

- currentTsPosition:

    current value of time shifter position

- requestedTsDelay:

    Delay to apply to the phase shifter

- DelayTsChange:

    Change phase shifter by requested value

- relAbsolutTsPos:

    True for relative, False for absolute

- stopPsChange:

    Abort phase shift change

- opticalSynch:

    Display status of optical synchronization

- opticalSynchLock:

    Display lock status of optical synchronization

- opticalSynchJitter:

    Display status of optical synchronization jitter

- opticalSynchMode:

    Optical synch. mode (RF / Optical)

- setOpticalDelay:

    Delay to apply to optical delay line

- applyOpticalDelay:

    change the optical delay by requeste value

- currentOpticalDelay:

    Current position of optical delay

- relAbsolutDelayLine:

    True for relative, False for absolute

- TsJitter:

    Optical Synchronization Jitter

- triggerFE_DOWNSTREAM:

    Current trigger delay FE DOWNSTREAM

- triggerFE_UPSTREAM:

    Current trigger delay FE UPSTREAM

- getCurrentHardwareStatus:

    Read configuration from hardware

- lastShiftDelay:

    FE delay value from the prevoius shift

- setLastShiftDelay:

    Bring the delay to position from the previus shift

- clearLock:

    In case of STATE == changing bring the state to Normal

- mPCCLKPhaseSetValue:

    Master PC CLK Phase Value

- sPCCLKPhaseSetValue:

    Slave PC CLK Phase Value

- delayBPMasterSetValue:

    Master BP delay Value

- delayBPSlaveSetValue:

    Slave BP delay Value

- resetError:

    Reset error state

- upstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for upstream instrument

- downstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for downstream instrument

- shiftChange:

    Swaps MASTER and SLAVE properties between upstream and downstream instrument

- isOxcActive:

    Status of optical lock (True: OPTICAL mode, False: RF mode)

- requestedDelay:

    Relative delay to be applied by delay change (Trigger Position)

- delayChange:

    Change delay value by applying (relative) offset

- mPCCLKPhaseP:

    Increment PC master Phase

- mPCCLKPhaseM:

    Decrement PC master Phase

- sPCCLKPhaseP:

    Increment slave PC Phase

- sPCCLKPhaseM:

    Decrement slave PC phase

- savemSWPCCLKPhase:

    Save new software phase value for PCm

- savesSWPCCLKPhase:

    Save new software phase value for PCs

- mBurstStartApply:

    Apply Burst Start Pos

- takemidTsValue:

    Take mid value of phase shifter

- logBoardsStatus:

    JSON string describing master and slave board settings.Usually updated when user actions are taken

- logFineDelay:

    JSON string describing fine delay settings.Usually updated when user actions are taken

- imgprocDevice:

    Device ID of image processor used for feedback

- temDevice:

    id of tem device

- temChannel:

    TEM channel to be controlled

- xCoefWeight:

    weight of X coefficient

- yCoefWeight:

    weight of Y coefficient

- axCoefOld:

    Value of Ax Coefficient saved prior to calibration

- ayCoefOld:

    Value of Ay Coefficient saved prior to calibration

- xBeamCenterTarget:

    desired value for Beam Center X coordinate

- yBeamCenterTarget:

    desired value for Beam Center Y coordinate

- beamCenterMaxDisplacement:

    maximum allowed displacement for Center of Mass from target position

- maxTemDrift:

    Maximum value allowed for TEM drift

- averageNumber:

    number of values of beam center coordinates to average

- timeoutImageProcessorValues:

    Time to wait before going in error when values from image processor are not updating

- imageSettlementTime:

    Time to wait before reading beam center coordinates aftermoving TEM setpoint

- calibrationStep:

    TEM setpoint step size for calibration

- calibrationStepsNumber:

    Number of TEM calibration steps

- maxTimeNotRegulating:

    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

- setCurrentPosAsTarget:

    Set current beam position as target

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

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

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

###### LAB_CHILLER_REMOTE_START

Instance id: | LA1_LAS_PPL/DCTRL/LAB_CHILLER_REMOTE_START
Host: | exflcon14n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

Device Schema Description

- _serverId_:

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

- _deviceId_:

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

- _connection_:

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

- visibility:

    Configures who is allowed to see this device at all

- deviceId:

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

- classId:

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

- classVersion:

    The version of the class of this device defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- alarmCondition:

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

- lastCommand:

    The last slot called.

- archive:

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

- useTimeserver:

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

- progress:

    The progress of the current action

- heartbeatInterval:

    The heartbeat interval

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

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

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

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

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

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

- epsilon:

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

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

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

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

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

- maxStateUpdateRate:

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

- noisyStateUpdateRateValue:

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

- isStateUpdateNoisy:

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

- reset:

    Resets the PLC hardware

- enableInterlockedSlots:

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

- disableInterlockedSlots:

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

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

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

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

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

- readHardware:

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

- force:

    ???

- trigger:

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

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- value:

    Analog input of ADC.

- scale:

    Scaling factor for analog value.

- offset:

    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!

- start:

    Instructs device to go to started state

- stop:

    Instructs device to go to stopped state

- resetADC:

    Reset ADC’s of FPGA in case of constant line, No signal

- resetDDR2:

    Resets DDR2 in case of constant line, No signal

- deviceFile:

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

- mapDirectory:

    Folder where all xml mapping files are located.

- numberRawSamples:

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

- delay:

    Delay between calibration images.

- skipSamples:

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

- triggerTime:

    Time between Triggers

- triggerTimeStat:

    Histogram of time between Triggers

- trainId:

    Current train ID as read from the FPGA

- config:

    Board related configuration parameters.

- dacNode:

    Set up DAC parameters

- channel_0:

    This is a channel of bunch of other parameters

- channel_1:

    This is a channel of bunch of other parameters

- channel_2:

    This is a channel of bunch of other parameters

- channel_3:

    This is a channel of bunch of other parameters

- channel_4:

    This is a channel of bunch of other parameters

- channel_5:

    This is a channel of bunch of other parameters

- channel_6:

    This is a channel of bunch of other parameters

- channel_7:

    This is a channel of bunch of other parameters

- channel_8:

    This is a channel of bunch of other parameters

- channel_9:

    This is a channel of bunch of other parameters

- semiRawValue:

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

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- timeServerId:

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

- Logger:

    Logging settings

- sendCommand:

    Send command to the instrument.

- replyToCommand:

    Reply to the command send to the instrument.

- gotoErrorOnPollFailure:

    Instrument will go to error if poll fails for all properties.

- autoConnect:

    Set True to automatically connect to device.

- pollingInterval:

    The interval for polling the instrument.

- enableHeartbeat:

    Enable Heartbeat

- heartbeatCommand:

    Text to send as heartbeat

- heartbeatReply:

    Heartbeat reply text

- heartbeatPeriod:

    Heartbeat period

- heartbeatTime:

    Last heartbeat time

- pollingTimeTaken:

    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

- pollNow:

    Poll instrument now!

- _connect_:

    Connects to the device

- disconnect:

    Disconnects from the device

- handshake:

    Set the state of the message roundtrip handshaking.

- baudRate:

    Set the transmit and receive baud rates on the RS-232 port.

- errorCount:

    The number of error records in the queue.

- measureType:

    Set the meter measurement mode (energy or power).

- statisticsMode:

    Set the statistics processing mode (on or off).

- variableDecimation:

    Set the pulse decimation rate (1-99999).

- apertureDiameter:

    Set the aperture diameter.

- wavelength:

    Set the current wavelength.

- gainCompensation:

    Enables or disables the gain compensation.

- gainFactor:

    Set the gain compensation factor.

- range:

    Set the measurement range (maximum expected measurement).

- batchSize:

    Set the statistics batch size.

- restartMode:

    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

- statStart:

    Terminates the current statistical batch and start a new one.

- statStop:

    Terminates the current statistical batch.

- triggerSource:

    Selects the trigger source (INTernal / EXTernal).

- triggerLevel:

    Set the trigger level (no effect when external trigger is selected).

- triggerSlope:

    Selects the external trigger edge (POSitive / NEGative).

- sequenceId:

    Set the sequence ID.

- triggerBus:

    Selects the trigger bus participation mode.

- itemSelect:

    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

- statItemSelect:

    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

- serialNumber:

    The serial number string.

- partNumber:

    The part number.

- modelName:

    The Model Name.

- calibrationDate:

    The calibration date.

- manifacturingDate:

    The manifacturing date.

- defaultWavelength:

    The default wavelength.

- measurementRefreshRate:

    The refresh rate of measurements.

- measurement:

    Last measurement.

- idType:

    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

- cameraId:

    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

- packetDelay:

    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

- autoPacketSize:

    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

- packetSize:

    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

- exposureTime:

    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

- triggerMode:

    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

- triggerActivation:

    This enumeration sets the signal transition needed to activate the selected trigger.

- autoGain:

    Configures automatic gain feature.

- gain:

    Sets the gain of the ADC converter.

- acquisitionMode:

    This property sets the image acquisition mode.

- frameCount:

    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

- xPeak1:

    x-position of peak in first calibration image.

- xFWHM1:

    x-FWHM in first calibration image.

- xPeak2:

    x-position of peak in second calibration image.

- xFWHM2:

    x-FWHM in second calibration image.

- delayUnit:

    Unit of the delay between calibration images.

- useAsCalibrationImage1:

    Use the current image as 1st calibration image.

- useAsCalibrationImage2:

    Use the current image as 2nd calibration image.

- calibrate:

  > perform calibrationStepsNumber steps of calibrationStep size starting and ending in symmetrical places relatively to initial position, both along X and Y, while measuring center of beam position.

  > Use these measurements to calculate axCoef and ayCoef.

  > Assumptions that are made: sin(x) ~= x x(y) axis of TEM parallel to x (y) axis of camera

- calibrationFactor:

    The calibration constant.

- beamShape:

    Time shape of the beam.

- xMinFit:

    Lower limit for the fit.

- xMaxFit:

    Upper limit for the fit.

- fitStatus:

    Error of fit procedure: 1-3 means good fit. See device documentation for further details.

- subtractPedestal:

    Subtract the pedestal, calculated from linear interpolation between first and last point.

- xPeak3:

    x-position of peak in the input image.

- xFWHM3:

    x-FWHM in the input image.

- pulseWidth:

    Duration of the pulse.

- ePulseWidth:

    Uncertainty of the pulse duration arising from fit procedure.

- switchToReady:

    Instructs the amplifier to go to ready state.

- switchOn:

    Instructs the amplifier to go to on state.

- switchOff:

    Instructs the amplifier to go to off state.

- closeShutter2:

    Instructs the amplifier to close Shutter 2.

- openShutter2:

    Instructs the amplifier to open Shutter 2.

- amphosIp:

    The IP address of the Amphos Control.

- amphosPort:

    The port of the Amphos Control.

- stateChanging:

    Laser is currently changing state.

- targetPower:

    Target laser power.

- chillerTemperature:

    Measured temperature of chiller.

- chillerFlow:

    Measured flow of chiller [l/min].

- chillerValvePosition:

    Measured valve position.

- shutter2IsOpen:

    Shutter2 State: False=closed True=open

- lambdaIsBusy:

    Lambda plate is moving.

- laserCurrent:

    Measured current of Amphos400.

- laserTemperature:

    Measured temperature of Amphos400.

- laserHumidity:

    Measured humidity of Amphos400.

- xfelCurrentCW1:

    Measured current of XFEL booster 1 (CW1).

- xfelCurrentCW2:

    Measured current of XFEL booster 1 (CW2).

- xfelCurrentQCW1:

    Measured current of XFEL booster 1 (QCW1).

- xfelCurrentQCW2:

    Measured current of XFEL booster 1 (QCW2).

- xfelCurrentQCW3:

    Measured current of XFEL booster 1 (QCW3).

- xfelCurrentQCW4:

    Measured current of XFEL booster 1 (QCW3).

- xfelTemperature:

    Measured temperature of XFEL booster 1.

- xfelHumidity:

    Measured humidity of XFEL booster 1.

- globalAlarmCondition:

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

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- log:

    Logging settings

- adc:

    fast ADC input device

- selectedAdcChannel:

    fast ADC channel in use for the loop

- maxPeakValue:

    Max absolute value for ADC peak. When peak is above this value step is applied

- tuneStage:

    motor controlling the stage to adjust laser path

- stageStep:

    value of stage tuning step size

- loopPeriod:

    Time interval for feedback cycle

- doublecheckWaitTime:

    after peak is above max, this time is waiting to check itagain, before applying step

- calibStepSize:

    Size of calibration step

- calibStepNum:

    Number of calibration steps

- calibAverageNum:

    number of peak values to be averaged for each calibration step

- reverseDirection:

    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

- conversionFactor:

    micrometers to femtoseconds conversion factor

- adcValueTimeout:

    if ADC value is not updated within this time, device goesin error state

- amphosAmpli:

    Karabo ID of Amphos Laser Amplifier

- triggerDelayDevice:

    Karabo ID of pplDelayControl device, used to read Pockels cell status

- moveToPlus:

    Move to +x position

- moveToMinus:

    Move to -x position

- moveToZero:

    Move to 0 position

- pathToProgramFiles:

    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

- correctionFile:

    The correction (.ct5) file, including path.

- useExternalTrigger:

    Use external trigger (if true) or auto-run (if false).

- startFromMinusX:

    Set loop initial position to -X

- jumpSpeed:

    The up/down jump speed [bits/ms].

- jumpAmplitude:

    The up/down jump amplitude [bits].

- delayTimePlus:

    Delay time, after moving to position +x.

- delayTimeMinus:

    Delay time, after moving to position -x.

- onTargetTolerance:

    The tolerance [bits] when checking that Galvo is on target position.

- onTargetPlus:

    Galvo is currently at +x position _and_ not moving.

- onTargetMinus:

    Galvo is currently at -x position _and_ not moving.

- laserOn:

    The value of the LASERON signal.

- digitalOut1:

    The value of the DIGITAL OUT1 signal.

- stopEventCode:

    Stop event code.

- galvoTemperature:

    Galvanometer scanner temperature.

- servoTemperature:

    Servo board temperature.

- agcVoltage:

    AGC voltage (PD supply voltage).

- dspCoreVoltage:

    DSP core supply voltage (1.8 V).

- dspIoVoltage:

    DSP IO voltage (3.3 V).

- analogSectVoltage:

    Analog section voltage (9 V).

- adConverterVoltage:

    AD converter supply voltage (5 V).

- galvoHeatingOut:

    Relative heating output of the corresponding galvanometer scanner heater.

- beamline:

    Beamline where to operate

- timingDevice:

    Device ID of PPL Delay Control Device

- galvoDevice:

    id of Galvo Controller

- downstreamSpectr1Device:

    Spectrometer 1 (FXE/SCS)

- upstreamSpectr1Device:

    Spectrometer 1 (SPB/SQS)

- currentExperiment:

    Current MASTER experiment (UPSTREAM or DOWNSTREAM)

- currentVersion:

    Current version

- correctionFactorMaster:

    Correction Factor Master

- correctionFactorSlave:

    Correction Factor Slave

- switchProgress:

    Switching Progress

- switchExperiment:

    Procedure to automatically swap between FXE and SPB delay control and Galvo settings

- on:

    Instructs the device to switch on

- off:

    Instructs device to switch off

- lastError:

    Last error message received. Time is set by front-end firmware.

- scpiTimeout:

    The SCPI communication timeout.

- baseFreq:

    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

- frontendReset:

    send reset command

- s7ack:

    acknowledge to s7 command

- s8ack:

    acknowledge to s8 command

- s9ack:

    acknowledge to s9 command

- laserEmission:

    True when laser ON, false when OFF

- generalStatus:

    True = OK, False = not OK

- temperatureStatus:

    True = OK, False = not OK

- delayBoardStatus:

    True = OK, False = not OK

- inputPin0Status:

    True = OK, False = not OK

- inputPin4Status:

    True = OK, False = not OK

- pd1Voltage:

    Photodiode 1 (TAB 2) voltage

- pd1VoltageAverage:

    Averaged PD1 (TAB 2) voltage

- pd2Voltage:

    Photodiode 2 (TAB 5) voltage

- pd2VoltageAverage:

    Averaged PD2 (TAB 5) voltage

- pd3Voltage:

    PD3 (SPCO 1) voltage

- pd3VoltageAverage:

    Averaged PD3 (SPCO 1) voltage

- pd4Voltage:

    PD4 (TAB 7) voltage

- pd4VoltageAverage:

    Averaged PD4 (TAB 7) voltage

- pd5Voltage:

    PD5 (SPCO2) voltage

- pd5VoltageAverage:

    Averaged PD5 (SPCO2) voltage

- pd6Voltage:

    PD6 voltage

- pd6VoltageAverage:

    Averaged PD6 voltage

- pd7Voltage:

    PD7 voltage

- pd7VoltageAverage:

    Averaged PD7 voltage

- pd8Voltage:

    PD8 voltage

- pd8VoltageAverage:

    Averaged PD8 voltage

- seederOutPower:

    photodiode 1

- xf1OutPower:

    Photodiode 7

- xf2OutPower:

    Photodiode 8

- seederStatus:

    True = OK, False = not OK

- generalSeederStatus:

    True = OK, False = not OK

- hiltiErrorStatus:

    True = OK, False = not OK

- remoteControl:

    if it is false we cannot see it

- regOnOff0:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- regOnOff1:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- setpAX0:

    Variable SetpAx[0] define the setpoint of the servo loop.

- setpAY0:

    Variable SetpAy[0] define the setpoint of the servo loop.

- sumA0:

    Sum signal of angle detector ‘A’

- sumB0:

    Sum signal of position detector ‘B’

- aX0:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY0:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX0:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY0:

    Variable By represents the measured position deviation in y direction from zero position

- rAX0:

    Regulator Output Ax

- rAY0:

    Regulator Output Ay

- rBX0:

    Regulator Output Bx

- rBY0:

    Regulator Output By

- rAXM0:

    Regulator Output AxM

- rAYM0:

    Regulator Output AyM

- rBXM0:

    Regulator Output BxM

- rBYM0:

    Regulator Output ByM

- setpAX1:

    Variable SetpAx[1] define the setpoint of the servo loop.

- setpAY1:

    Variable SetpAy[1] define the setpoint of the servo loop.

- sumA1:

    Sum signal of angle detector ‘A’

- sumB1:

    Sum signal of position detector ‘B’

- aX1:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY1:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX1:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY1:

    Variable By represents the measured position deviation in y direction from zero position

- rAX1:

    Regulator Output Ax

- rAY1:

    Regulator Output Ay

- rBX1:

    Regulator Output Bx

- rBY1:

    Regulator Output By

- rAXM1:

    Regulator Output AxM

- rAYM1:

    Regulator Output AyM

- rBXM1:

    Regulator Output BxM

- rBYM1:

    Regulator Output ByM

- stage1Id:

    Karabo device ID of first grating motor

- stage2Id:

    Karabo device ID of first grating motor

- tunnel:

    Location where doocs_device is deployed (e.g. ‘SASE1’)

- labx2MName:

    DOOCS name of X2 Master doocs_device

- labx2SName:

    DOOCS name of X2 Slave doocs_device

- timingShifterName:

    DOOCS name of Phase Shifter doocs_device

- manualTuning:

    Manual Tuning Enable

- useShifter:

    Set to True if optical synchronization is available

- midTsValue:

    Mid Value of Phase Shifter

- maxTsDelay:

    Maximum delay to add/subtract to phase shifter position

- maxTsJitter:

    Maximum allowed jitter

- laserOpModeList:

    Select Laser Op Mode

- activeLaserOpMode:

    Active Op laser Mode

- laserOpModeListApply:

    Apply Laser Operation Mode

- dmBCCAuto:

    Automatic loop on/off

- pCellState:

    Status of Pockels Cell, True = On

- pCellOn:

    Set Pockels cell on

- pCellOff:

    Set Pockels cell off

- AOMState:

    Status of AOM, True = On

- AOMOn:

    Set AOM on

- AOMOff:

    Set AOM off

- maxAllowedPcPhase:

    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

- mPCCLKPhase:

    Master PC Phase

- mSWPCCLKPhase:

    Master SW PC Phase

- mBurstWidth:

    Master burst width [us]

- mBurstWidthApply:

    Apply m Burst Width

- mBurstStart:

    Begining of the bursts the slave burst is +50ms)

- mBurstStartsms:

    Master burst starts pos. [us]

- sBurstStartsms:

    Sleve burst starts pos. [us]

- smBurstDiff:

    Different between muster and slave burst positione

- sPCCLKPhase:

    Master PC Phase

- sSWPCCLKPhase:

    Slave software PC PHase

- sBurstWidth:

    Slave burst width [us]

- sBurstWidthApply:

    Apply S Burst width

- delayBPMaster:

    Current delay of the master bunch pattern in clock unit (machine)

- delayBPMasterP:

    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterM:

    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterP24:

    Increment Master Bunch Pattern delay by 24 clock unit

- delayBPMasterM24:

    Decrement Master Bunch Pattern delay by 24 clock unit

- delayBPSlave:

    Current delay of the slave bunch pattern in clock unit (machine)

- delayBPSlaveP:

    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveM:

    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveP24:

    Increment Slave Bunch Pattern delay by 24 clock unit

- delayBPSlaveM24:

    Decrement Slave Bunch Pattern delay by 24 clock unit

- masterExpPattern:

    Select pattern for master experiment

- slaveExpPattern:

    Select pattern for slave experiment

- currentLaserPatterns:

    Current Laser Patterns

- currentMasterLaserPattern:

    Current Master Laser Patterns

- currentSlaveLaserPattern:

    Current Slave Laser Patterns

- currentSlaveLaserPatternN:

    Current Slave Laser Pattern

- fineDelayMaxCounts:

    Fine delay - maximum count number

- fineDelayValue:

    fine delay count value

- fineDelayValueT:

    fine delay time value

- fineDelayP:

    Increment fine delay

- fineDelayM:

    Decrement fine delay

- fineDelay9nsChange:

    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

- fineDelay9ns:

    Change Fine Delay by 9 ns

- minTsPosition:

    Minimum Timing Shifter Delay

- maxTsPosition:

    Maximum Timing Shifter Delay

- currentTsPosition:

    current value of time shifter position

- requestedTsDelay:

    Delay to apply to the phase shifter

- DelayTsChange:

    Change phase shifter by requested value

- relAbsolutTsPos:

    True for relative, False for absolute

- stopPsChange:

    Abort phase shift change

- opticalSynch:

    Display status of optical synchronization

- opticalSynchLock:

    Display lock status of optical synchronization

- opticalSynchJitter:

    Display status of optical synchronization jitter

- opticalSynchMode:

    Optical synch. mode (RF / Optical)

- setOpticalDelay:

    Delay to apply to optical delay line

- applyOpticalDelay:

    change the optical delay by requeste value

- currentOpticalDelay:

    Current position of optical delay

- relAbsolutDelayLine:

    True for relative, False for absolute

- TsJitter:

    Optical Synchronization Jitter

- triggerFE_DOWNSTREAM:

    Current trigger delay FE DOWNSTREAM

- triggerFE_UPSTREAM:

    Current trigger delay FE UPSTREAM

- getCurrentHardwareStatus:

    Read configuration from hardware

- lastShiftDelay:

    FE delay value from the prevoius shift

- setLastShiftDelay:

    Bring the delay to position from the previus shift

- clearLock:

    In case of STATE == changing bring the state to Normal

- mPCCLKPhaseSetValue:

    Master PC CLK Phase Value

- sPCCLKPhaseSetValue:

    Slave PC CLK Phase Value

- delayBPMasterSetValue:

    Master BP delay Value

- delayBPSlaveSetValue:

    Slave BP delay Value

- resetError:

    Reset error state

- upstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for upstream instrument

- downstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for downstream instrument

- shiftChange:

    Swaps MASTER and SLAVE properties between upstream and downstream instrument

- isOxcActive:

    Status of optical lock (True: OPTICAL mode, False: RF mode)

- requestedDelay:

    Relative delay to be applied by delay change (Trigger Position)

- delayChange:

    Change delay value by applying (relative) offset

- mPCCLKPhaseP:

    Increment PC master Phase

- mPCCLKPhaseM:

    Decrement PC master Phase

- sPCCLKPhaseP:

    Increment slave PC Phase

- sPCCLKPhaseM:

    Decrement slave PC phase

- savemSWPCCLKPhase:

    Save new software phase value for PCm

- savesSWPCCLKPhase:

    Save new software phase value for PCs

- mBurstStartApply:

    Apply Burst Start Pos

- takemidTsValue:

    Take mid value of phase shifter

- logBoardsStatus:

    JSON string describing master and slave board settings.Usually updated when user actions are taken

- logFineDelay:

    JSON string describing fine delay settings.Usually updated when user actions are taken

- imgprocDevice:

    Device ID of image processor used for feedback

- temDevice:

    id of tem device

- temChannel:

    TEM channel to be controlled

- xCoefWeight:

    weight of X coefficient

- yCoefWeight:

    weight of Y coefficient

- axCoefOld:

    Value of Ax Coefficient saved prior to calibration

- ayCoefOld:

    Value of Ay Coefficient saved prior to calibration

- xBeamCenterTarget:

    desired value for Beam Center X coordinate

- yBeamCenterTarget:

    desired value for Beam Center Y coordinate

- beamCenterMaxDisplacement:

    maximum allowed displacement for Center of Mass from target position

- maxTemDrift:

    Maximum value allowed for TEM drift

- averageNumber:

    number of values of beam center coordinates to average

- timeoutImageProcessorValues:

    Time to wait before going in error when values from image processor are not updating

- imageSettlementTime:

    Time to wait before reading beam center coordinates aftermoving TEM setpoint

- calibrationStep:

    TEM setpoint step size for calibration

- calibrationStepsNumber:

    Number of TEM calibration steps

- maxTimeNotRegulating:

    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

- setCurrentPosAsTarget:

    Set current beam position as target

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

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

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

###### NANOSSPARE1

Instance id: | LA1_LAS_PPL/DCTRL/NANOSSPARE1
Host: | exflcon14n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

Device Schema Description

- _serverId_:

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

- _deviceId_:

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

- _connection_:

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

- visibility:

    Configures who is allowed to see this device at all

- deviceId:

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

- classId:

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

- classVersion:

    The version of the class of this device defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- alarmCondition:

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

- lastCommand:

    The last slot called.

- archive:

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

- useTimeserver:

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

- progress:

    The progress of the current action

- heartbeatInterval:

    The heartbeat interval

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

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

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

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

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

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

- epsilon:

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

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

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

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

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

- maxStateUpdateRate:

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

- noisyStateUpdateRateValue:

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

- isStateUpdateNoisy:

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

- reset:

    Resets the PLC hardware

- enableInterlockedSlots:

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

- disableInterlockedSlots:

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

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

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

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

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

- readHardware:

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

- force:

    ???

- trigger:

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

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- value:

    Analog input of ADC.

- scale:

    Scaling factor for analog value.

- offset:

    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!

- start:

    Instructs device to go to started state

- stop:

    Instructs device to go to stopped state

- resetADC:

    Reset ADC’s of FPGA in case of constant line, No signal

- resetDDR2:

    Resets DDR2 in case of constant line, No signal

- deviceFile:

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

- mapDirectory:

    Folder where all xml mapping files are located.

- numberRawSamples:

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

- delay:

    Delay between calibration images.

- skipSamples:

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

- triggerTime:

    Time between Triggers

- triggerTimeStat:

    Histogram of time between Triggers

- trainId:

    Current train ID as read from the FPGA

- config:

    Board related configuration parameters.

- dacNode:

    Set up DAC parameters

- channel_0:

    This is a channel of bunch of other parameters

- channel_1:

    This is a channel of bunch of other parameters

- channel_2:

    This is a channel of bunch of other parameters

- channel_3:

    This is a channel of bunch of other parameters

- channel_4:

    This is a channel of bunch of other parameters

- channel_5:

    This is a channel of bunch of other parameters

- channel_6:

    This is a channel of bunch of other parameters

- channel_7:

    This is a channel of bunch of other parameters

- channel_8:

    This is a channel of bunch of other parameters

- channel_9:

    This is a channel of bunch of other parameters

- semiRawValue:

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

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- timeServerId:

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

- Logger:

    Logging settings

- sendCommand:

    Send command to the instrument.

- replyToCommand:

    Reply to the command send to the instrument.

- gotoErrorOnPollFailure:

    Instrument will go to error if poll fails for all properties.

- autoConnect:

    Set True to automatically connect to device.

- pollingInterval:

    The interval for polling the instrument.

- enableHeartbeat:

    Enable Heartbeat

- heartbeatCommand:

    Text to send as heartbeat

- heartbeatReply:

    Heartbeat reply text

- heartbeatPeriod:

    Heartbeat period

- heartbeatTime:

    Last heartbeat time

- pollingTimeTaken:

    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

- pollNow:

    Poll instrument now!

- _connect_:

    Connects to the device

- disconnect:

    Disconnects from the device

- handshake:

    Set the state of the message roundtrip handshaking.

- baudRate:

    Set the transmit and receive baud rates on the RS-232 port.

- errorCount:

    The number of error records in the queue.

- measureType:

    Set the meter measurement mode (energy or power).

- statisticsMode:

    Set the statistics processing mode (on or off).

- variableDecimation:

    Set the pulse decimation rate (1-99999).

- apertureDiameter:

    Set the aperture diameter.

- wavelength:

    Set the current wavelength.

- gainCompensation:

    Enables or disables the gain compensation.

- gainFactor:

    Set the gain compensation factor.

- range:

    Set the measurement range (maximum expected measurement).

- batchSize:

    Set the statistics batch size.

- restartMode:

    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

- statStart:

    Terminates the current statistical batch and start a new one.

- statStop:

    Terminates the current statistical batch.

- triggerSource:

    Selects the trigger source (INTernal / EXTernal).

- triggerLevel:

    Set the trigger level (no effect when external trigger is selected).

- triggerSlope:

    Selects the external trigger edge (POSitive / NEGative).

- sequenceId:

    Set the sequence ID.

- triggerBus:

    Selects the trigger bus participation mode.

- itemSelect:

    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

- statItemSelect:

    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

- serialNumber:

    The serial number string.

- partNumber:

    The part number.

- modelName:

    The Model Name.

- calibrationDate:

    The calibration date.

- manifacturingDate:

    The manifacturing date.

- defaultWavelength:

    The default wavelength.

- measurementRefreshRate:

    The refresh rate of measurements.

- measurement:

    Last measurement.

- idType:

    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

- cameraId:

    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

- packetDelay:

    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

- autoPacketSize:

    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

- packetSize:

    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

- exposureTime:

    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

- triggerMode:

    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

- triggerActivation:

    This enumeration sets the signal transition needed to activate the selected trigger.

- autoGain:

    Configures automatic gain feature.

- gain:

    Sets the gain of the ADC converter.

- acquisitionMode:

    This property sets the image acquisition mode.

- frameCount:

    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

- xPeak1:

    x-position of peak in first calibration image.

- xFWHM1:

    x-FWHM in first calibration image.

- xPeak2:

    x-position of peak in second calibration image.

- xFWHM2:

    x-FWHM in second calibration image.

- delayUnit:

    Unit of the delay between calibration images.

- useAsCalibrationImage1:

    Use the current image as 1st calibration image.

- useAsCalibrationImage2:

    Use the current image as 2nd calibration image.

- calibrate:

  > perform calibrationStepsNumber steps of calibrationStep size starting and ending in symmetrical places relatively to initial position, both along X and Y, while measuring center of beam position.

  > Use these measurements to calculate axCoef and ayCoef.

  > Assumptions that are made: sin(x) ~= x x(y) axis of TEM parallel to x (y) axis of camera

- calibrationFactor:

    The calibration constant.

- beamShape:

    Time shape of the beam.

- xMinFit:

    Lower limit for the fit.

- xMaxFit:

    Upper limit for the fit.

- fitStatus:

    Error of fit procedure: 1-3 means good fit. See device documentation for further details.

- subtractPedestal:

    Subtract the pedestal, calculated from linear interpolation between first and last point.

- xPeak3:

    x-position of peak in the input image.

- xFWHM3:

    x-FWHM in the input image.

- pulseWidth:

    Duration of the pulse.

- ePulseWidth:

    Uncertainty of the pulse duration arising from fit procedure.

- switchToReady:

    Instructs the amplifier to go to ready state.

- switchOn:

    Instructs the amplifier to go to on state.

- switchOff:

    Instructs the amplifier to go to off state.

- closeShutter2:

    Instructs the amplifier to close Shutter 2.

- openShutter2:

    Instructs the amplifier to open Shutter 2.

- amphosIp:

    The IP address of the Amphos Control.

- amphosPort:

    The port of the Amphos Control.

- stateChanging:

    Laser is currently changing state.

- targetPower:

    Target laser power.

- chillerTemperature:

    Measured temperature of chiller.

- chillerFlow:

    Measured flow of chiller [l/min].

- chillerValvePosition:

    Measured valve position.

- shutter2IsOpen:

    Shutter2 State: False=closed True=open

- lambdaIsBusy:

    Lambda plate is moving.

- laserCurrent:

    Measured current of Amphos400.

- laserTemperature:

    Measured temperature of Amphos400.

- laserHumidity:

    Measured humidity of Amphos400.

- xfelCurrentCW1:

    Measured current of XFEL booster 1 (CW1).

- xfelCurrentCW2:

    Measured current of XFEL booster 1 (CW2).

- xfelCurrentQCW1:

    Measured current of XFEL booster 1 (QCW1).

- xfelCurrentQCW2:

    Measured current of XFEL booster 1 (QCW2).

- xfelCurrentQCW3:

    Measured current of XFEL booster 1 (QCW3).

- xfelCurrentQCW4:

    Measured current of XFEL booster 1 (QCW3).

- xfelTemperature:

    Measured temperature of XFEL booster 1.

- xfelHumidity:

    Measured humidity of XFEL booster 1.

- globalAlarmCondition:

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

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- log:

    Logging settings

- adc:

    fast ADC input device

- selectedAdcChannel:

    fast ADC channel in use for the loop

- maxPeakValue:

    Max absolute value for ADC peak. When peak is above this value step is applied

- tuneStage:

    motor controlling the stage to adjust laser path

- stageStep:

    value of stage tuning step size

- loopPeriod:

    Time interval for feedback cycle

- doublecheckWaitTime:

    after peak is above max, this time is waiting to check itagain, before applying step

- calibStepSize:

    Size of calibration step

- calibStepNum:

    Number of calibration steps

- calibAverageNum:

    number of peak values to be averaged for each calibration step

- reverseDirection:

    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

- conversionFactor:

    micrometers to femtoseconds conversion factor

- adcValueTimeout:

    if ADC value is not updated within this time, device goesin error state

- amphosAmpli:

    Karabo ID of Amphos Laser Amplifier

- triggerDelayDevice:

    Karabo ID of pplDelayControl device, used to read Pockels cell status

- moveToPlus:

    Move to +x position

- moveToMinus:

    Move to -x position

- moveToZero:

    Move to 0 position

- pathToProgramFiles:

    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

- correctionFile:

    The correction (.ct5) file, including path.

- useExternalTrigger:

    Use external trigger (if true) or auto-run (if false).

- startFromMinusX:

    Set loop initial position to -X

- jumpSpeed:

    The up/down jump speed [bits/ms].

- jumpAmplitude:

    The up/down jump amplitude [bits].

- delayTimePlus:

    Delay time, after moving to position +x.

- delayTimeMinus:

    Delay time, after moving to position -x.

- onTargetTolerance:

    The tolerance [bits] when checking that Galvo is on target position.

- onTargetPlus:

    Galvo is currently at +x position _and_ not moving.

- onTargetMinus:

    Galvo is currently at -x position _and_ not moving.

- laserOn:

    The value of the LASERON signal.

- digitalOut1:

    The value of the DIGITAL OUT1 signal.

- stopEventCode:

    Stop event code.

- galvoTemperature:

    Galvanometer scanner temperature.

- servoTemperature:

    Servo board temperature.

- agcVoltage:

    AGC voltage (PD supply voltage).

- dspCoreVoltage:

    DSP core supply voltage (1.8 V).

- dspIoVoltage:

    DSP IO voltage (3.3 V).

- analogSectVoltage:

    Analog section voltage (9 V).

- adConverterVoltage:

    AD converter supply voltage (5 V).

- galvoHeatingOut:

    Relative heating output of the corresponding galvanometer scanner heater.

- beamline:

    Beamline where to operate

- timingDevice:

    Device ID of PPL Delay Control Device

- galvoDevice:

    id of Galvo Controller

- downstreamSpectr1Device:

    Spectrometer 1 (FXE/SCS)

- upstreamSpectr1Device:

    Spectrometer 1 (SPB/SQS)

- currentExperiment:

    Current MASTER experiment (UPSTREAM or DOWNSTREAM)

- currentVersion:

    Current version

- correctionFactorMaster:

    Correction Factor Master

- correctionFactorSlave:

    Correction Factor Slave

- switchProgress:

    Switching Progress

- switchExperiment:

    Procedure to automatically swap between FXE and SPB delay control and Galvo settings

- on:

    Instructs the device to switch on

- off:

    Instructs device to switch off

- lastError:

    Last error message received. Time is set by front-end firmware.

- scpiTimeout:

    The SCPI communication timeout.

- baseFreq:

    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

- frontendReset:

    send reset command

- s7ack:

    acknowledge to s7 command

- s8ack:

    acknowledge to s8 command

- s9ack:

    acknowledge to s9 command

- laserEmission:

    True when laser ON, false when OFF

- generalStatus:

    True = OK, False = not OK

- temperatureStatus:

    True = OK, False = not OK

- delayBoardStatus:

    True = OK, False = not OK

- inputPin0Status:

    True = OK, False = not OK

- inputPin4Status:

    True = OK, False = not OK

- pd1Voltage:

    Photodiode 1 (TAB 2) voltage

- pd1VoltageAverage:

    Averaged PD1 (TAB 2) voltage

- pd2Voltage:

    Photodiode 2 (TAB 5) voltage

- pd2VoltageAverage:

    Averaged PD2 (TAB 5) voltage

- pd3Voltage:

    PD3 (SPCO 1) voltage

- pd3VoltageAverage:

    Averaged PD3 (SPCO 1) voltage

- pd4Voltage:

    PD4 (TAB 7) voltage

- pd4VoltageAverage:

    Averaged PD4 (TAB 7) voltage

- pd5Voltage:

    PD5 (SPCO2) voltage

- pd5VoltageAverage:

    Averaged PD5 (SPCO2) voltage

- pd6Voltage:

    PD6 voltage

- pd6VoltageAverage:

    Averaged PD6 voltage

- pd7Voltage:

    PD7 voltage

- pd7VoltageAverage:

    Averaged PD7 voltage

- pd8Voltage:

    PD8 voltage

- pd8VoltageAverage:

    Averaged PD8 voltage

- seederOutPower:

    photodiode 1

- xf1OutPower:

    Photodiode 7

- xf2OutPower:

    Photodiode 8

- seederStatus:

    True = OK, False = not OK

- generalSeederStatus:

    True = OK, False = not OK

- hiltiErrorStatus:

    True = OK, False = not OK

- remoteControl:

    if it is false we cannot see it

- regOnOff0:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- regOnOff1:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- setpAX0:

    Variable SetpAx[0] define the setpoint of the servo loop.

- setpAY0:

    Variable SetpAy[0] define the setpoint of the servo loop.

- sumA0:

    Sum signal of angle detector ‘A’

- sumB0:

    Sum signal of position detector ‘B’

- aX0:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY0:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX0:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY0:

    Variable By represents the measured position deviation in y direction from zero position

- rAX0:

    Regulator Output Ax

- rAY0:

    Regulator Output Ay

- rBX0:

    Regulator Output Bx

- rBY0:

    Regulator Output By

- rAXM0:

    Regulator Output AxM

- rAYM0:

    Regulator Output AyM

- rBXM0:

    Regulator Output BxM

- rBYM0:

    Regulator Output ByM

- setpAX1:

    Variable SetpAx[1] define the setpoint of the servo loop.

- setpAY1:

    Variable SetpAy[1] define the setpoint of the servo loop.

- sumA1:

    Sum signal of angle detector ‘A’

- sumB1:

    Sum signal of position detector ‘B’

- aX1:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY1:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX1:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY1:

    Variable By represents the measured position deviation in y direction from zero position

- rAX1:

    Regulator Output Ax

- rAY1:

    Regulator Output Ay

- rBX1:

    Regulator Output Bx

- rBY1:

    Regulator Output By

- rAXM1:

    Regulator Output AxM

- rAYM1:

    Regulator Output AyM

- rBXM1:

    Regulator Output BxM

- rBYM1:

    Regulator Output ByM

- stage1Id:

    Karabo device ID of first grating motor

- stage2Id:

    Karabo device ID of first grating motor

- tunnel:

    Location where doocs_device is deployed (e.g. ‘SASE1’)

- labx2MName:

    DOOCS name of X2 Master doocs_device

- labx2SName:

    DOOCS name of X2 Slave doocs_device

- timingShifterName:

    DOOCS name of Phase Shifter doocs_device

- manualTuning:

    Manual Tuning Enable

- useShifter:

    Set to True if optical synchronization is available

- midTsValue:

    Mid Value of Phase Shifter

- maxTsDelay:

    Maximum delay to add/subtract to phase shifter position

- maxTsJitter:

    Maximum allowed jitter

- laserOpModeList:

    Select Laser Op Mode

- activeLaserOpMode:

    Active Op laser Mode

- laserOpModeListApply:

    Apply Laser Operation Mode

- dmBCCAuto:

    Automatic loop on/off

- pCellState:

    Status of Pockels Cell, True = On

- pCellOn:

    Set Pockels cell on

- pCellOff:

    Set Pockels cell off

- AOMState:

    Status of AOM, True = On

- AOMOn:

    Set AOM on

- AOMOff:

    Set AOM off

- maxAllowedPcPhase:

    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

- mPCCLKPhase:

    Master PC Phase

- mSWPCCLKPhase:

    Master SW PC Phase

- mBurstWidth:

    Master burst width [us]

- mBurstWidthApply:

    Apply m Burst Width

- mBurstStart:

    Begining of the bursts the slave burst is +50ms)

- mBurstStartsms:

    Master burst starts pos. [us]

- sBurstStartsms:

    Sleve burst starts pos. [us]

- smBurstDiff:

    Different between muster and slave burst positione

- sPCCLKPhase:

    Master PC Phase

- sSWPCCLKPhase:

    Slave software PC PHase

- sBurstWidth:

    Slave burst width [us]

- sBurstWidthApply:

    Apply S Burst width

- delayBPMaster:

    Current delay of the master bunch pattern in clock unit (machine)

- delayBPMasterP:

    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterM:

    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterP24:

    Increment Master Bunch Pattern delay by 24 clock unit

- delayBPMasterM24:

    Decrement Master Bunch Pattern delay by 24 clock unit

- delayBPSlave:

    Current delay of the slave bunch pattern in clock unit (machine)

- delayBPSlaveP:

    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveM:

    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveP24:

    Increment Slave Bunch Pattern delay by 24 clock unit

- delayBPSlaveM24:

    Decrement Slave Bunch Pattern delay by 24 clock unit

- masterExpPattern:

    Select pattern for master experiment

- slaveExpPattern:

    Select pattern for slave experiment

- currentLaserPatterns:

    Current Laser Patterns

- currentMasterLaserPattern:

    Current Master Laser Patterns

- currentSlaveLaserPattern:

    Current Slave Laser Patterns

- currentSlaveLaserPatternN:

    Current Slave Laser Pattern

- fineDelayMaxCounts:

    Fine delay - maximum count number

- fineDelayValue:

    fine delay count value

- fineDelayValueT:

    fine delay time value

- fineDelayP:

    Increment fine delay

- fineDelayM:

    Decrement fine delay

- fineDelay9nsChange:

    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

- fineDelay9ns:

    Change Fine Delay by 9 ns

- minTsPosition:

    Minimum Timing Shifter Delay

- maxTsPosition:

    Maximum Timing Shifter Delay

- currentTsPosition:

    current value of time shifter position

- requestedTsDelay:

    Delay to apply to the phase shifter

- DelayTsChange:

    Change phase shifter by requested value

- relAbsolutTsPos:

    True for relative, False for absolute

- stopPsChange:

    Abort phase shift change

- opticalSynch:

    Display status of optical synchronization

- opticalSynchLock:

    Display lock status of optical synchronization

- opticalSynchJitter:

    Display status of optical synchronization jitter

- opticalSynchMode:

    Optical synch. mode (RF / Optical)

- setOpticalDelay:

    Delay to apply to optical delay line

- applyOpticalDelay:

    change the optical delay by requeste value

- currentOpticalDelay:

    Current position of optical delay

- relAbsolutDelayLine:

    True for relative, False for absolute

- TsJitter:

    Optical Synchronization Jitter

- triggerFE_DOWNSTREAM:

    Current trigger delay FE DOWNSTREAM

- triggerFE_UPSTREAM:

    Current trigger delay FE UPSTREAM

- getCurrentHardwareStatus:

    Read configuration from hardware

- lastShiftDelay:

    FE delay value from the prevoius shift

- setLastShiftDelay:

    Bring the delay to position from the previus shift

- clearLock:

    In case of STATE == changing bring the state to Normal

- mPCCLKPhaseSetValue:

    Master PC CLK Phase Value

- sPCCLKPhaseSetValue:

    Slave PC CLK Phase Value

- delayBPMasterSetValue:

    Master BP delay Value

- delayBPSlaveSetValue:

    Slave BP delay Value

- resetError:

    Reset error state

- upstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for upstream instrument

- downstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for downstream instrument

- shiftChange:

    Swaps MASTER and SLAVE properties between upstream and downstream instrument

- isOxcActive:

    Status of optical lock (True: OPTICAL mode, False: RF mode)

- requestedDelay:

    Relative delay to be applied by delay change (Trigger Position)

- delayChange:

    Change delay value by applying (relative) offset

- mPCCLKPhaseP:

    Increment PC master Phase

- mPCCLKPhaseM:

    Decrement PC master Phase

- sPCCLKPhaseP:

    Increment slave PC Phase

- sPCCLKPhaseM:

    Decrement slave PC phase

- savemSWPCCLKPhase:

    Save new software phase value for PCm

- savesSWPCCLKPhase:

    Save new software phase value for PCs

- mBurstStartApply:

    Apply Burst Start Pos

- takemidTsValue:

    Take mid value of phase shifter

- logBoardsStatus:

    JSON string describing master and slave board settings.Usually updated when user actions are taken

- logFineDelay:

    JSON string describing fine delay settings.Usually updated when user actions are taken

- imgprocDevice:

    Device ID of image processor used for feedback

- temDevice:

    id of tem device

- temChannel:

    TEM channel to be controlled

- xCoefWeight:

    weight of X coefficient

- yCoefWeight:

    weight of Y coefficient

- axCoefOld:

    Value of Ax Coefficient saved prior to calibration

- ayCoefOld:

    Value of Ay Coefficient saved prior to calibration

- xBeamCenterTarget:

    desired value for Beam Center X coordinate

- yBeamCenterTarget:

    desired value for Beam Center Y coordinate

- beamCenterMaxDisplacement:

    maximum allowed displacement for Center of Mass from target position

- maxTemDrift:

    Maximum value allowed for TEM drift

- averageNumber:

    number of values of beam center coordinates to average

- timeoutImageProcessorValues:

    Time to wait before going in error when values from image processor are not updating

- imageSettlementTime:

    Time to wait before reading beam center coordinates aftermoving TEM setpoint

- calibrationStep:

    TEM setpoint step size for calibration

- calibrationStepsNumber:

    Number of TEM calibration steps

- maxTimeNotRegulating:

    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

- setCurrentPosAsTarget:

    Set current beam position as target

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

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

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

###### TRACEYCOMP_FXE_1

Instance id: | LA1_LAS_PPL/DCTRL/TRACEYCOMP_FXE_1
Host: | exflcon14n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

Device Schema Description

- _serverId_:

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

- _deviceId_:

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

- _connection_:

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

- visibility:

    Configures who is allowed to see this device at all

- deviceId:

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

- classId:

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

- classVersion:

    The version of the class of this device defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- alarmCondition:

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

- lastCommand:

    The last slot called.

- archive:

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

- useTimeserver:

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

- progress:

    The progress of the current action

- heartbeatInterval:

    The heartbeat interval

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

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

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

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

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

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

- epsilon:

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

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

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

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

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

- maxStateUpdateRate:

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

- noisyStateUpdateRateValue:

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

- isStateUpdateNoisy:

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

- reset:

    Resets the PLC hardware

- enableInterlockedSlots:

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

- disableInterlockedSlots:

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

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

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

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

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

- readHardware:

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

- force:

    ???

- trigger:

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

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- value:

    Analog input of ADC.

- scale:

    Scaling factor for analog value.

- offset:

    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!

- start:

    Instructs device to go to started state

- stop:

    Instructs device to go to stopped state

- resetADC:

    Reset ADC’s of FPGA in case of constant line, No signal

- resetDDR2:

    Resets DDR2 in case of constant line, No signal

- deviceFile:

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

- mapDirectory:

    Folder where all xml mapping files are located.

- numberRawSamples:

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

- delay:

    Delay between calibration images.

- skipSamples:

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

- triggerTime:

    Time between Triggers

- triggerTimeStat:

    Histogram of time between Triggers

- trainId:

    Current train ID as read from the FPGA

- config:

    Board related configuration parameters.

- dacNode:

    Set up DAC parameters

- channel_0:

    This is a channel of bunch of other parameters

- channel_1:

    This is a channel of bunch of other parameters

- channel_2:

    This is a channel of bunch of other parameters

- channel_3:

    This is a channel of bunch of other parameters

- channel_4:

    This is a channel of bunch of other parameters

- channel_5:

    This is a channel of bunch of other parameters

- channel_6:

    This is a channel of bunch of other parameters

- channel_7:

    This is a channel of bunch of other parameters

- channel_8:

    This is a channel of bunch of other parameters

- channel_9:

    This is a channel of bunch of other parameters

- semiRawValue:

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

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- timeServerId:

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

- Logger:

    Logging settings

- sendCommand:

    Send command to the instrument.

- replyToCommand:

    Reply to the command send to the instrument.

- gotoErrorOnPollFailure:

    Instrument will go to error if poll fails for all properties.

- autoConnect:

    Set True to automatically connect to device.

- pollingInterval:

    The interval for polling the instrument.

- enableHeartbeat:

    Enable Heartbeat

- heartbeatCommand:

    Text to send as heartbeat

- heartbeatReply:

    Heartbeat reply text

- heartbeatPeriod:

    Heartbeat period

- heartbeatTime:

    Last heartbeat time

- pollingTimeTaken:

    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

- pollNow:

    Poll instrument now!

- _connect_:

    Connects to the device

- disconnect:

    Disconnects from the device

- handshake:

    Set the state of the message roundtrip handshaking.

- baudRate:

    Set the transmit and receive baud rates on the RS-232 port.

- errorCount:

    The number of error records in the queue.

- measureType:

    Set the meter measurement mode (energy or power).

- statisticsMode:

    Set the statistics processing mode (on or off).

- variableDecimation:

    Set the pulse decimation rate (1-99999).

- apertureDiameter:

    Set the aperture diameter.

- wavelength:

    Set the current wavelength.

- gainCompensation:

    Enables or disables the gain compensation.

- gainFactor:

    Set the gain compensation factor.

- range:

    Set the measurement range (maximum expected measurement).

- batchSize:

    Set the statistics batch size.

- restartMode:

    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

- statStart:

    Terminates the current statistical batch and start a new one.

- statStop:

    Terminates the current statistical batch.

- triggerSource:

    Selects the trigger source (INTernal / EXTernal).

- triggerLevel:

    Set the trigger level (no effect when external trigger is selected).

- triggerSlope:

    Selects the external trigger edge (POSitive / NEGative).

- sequenceId:

    Set the sequence ID.

- triggerBus:

    Selects the trigger bus participation mode.

- itemSelect:

    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

- statItemSelect:

    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

- serialNumber:

    The serial number string.

- partNumber:

    The part number.

- modelName:

    The Model Name.

- calibrationDate:

    The calibration date.

- manifacturingDate:

    The manifacturing date.

- defaultWavelength:

    The default wavelength.

- measurementRefreshRate:

    The refresh rate of measurements.

- measurement:

    Last measurement.

- idType:

    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

- cameraId:

    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

- packetDelay:

    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

- autoPacketSize:

    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

- packetSize:

    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

- exposureTime:

    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

- triggerMode:

    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

- triggerActivation:

    This enumeration sets the signal transition needed to activate the selected trigger.

- autoGain:

    Configures automatic gain feature.

- gain:

    Sets the gain of the ADC converter.

- acquisitionMode:

    This property sets the image acquisition mode.

- frameCount:

    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

- xPeak1:

    x-position of peak in first calibration image.

- xFWHM1:

    x-FWHM in first calibration image.

- xPeak2:

    x-position of peak in second calibration image.

- xFWHM2:

    x-FWHM in second calibration image.

- delayUnit:

    Unit of the delay between calibration images.

- useAsCalibrationImage1:

    Use the current image as 1st calibration image.

- useAsCalibrationImage2:

    Use the current image as 2nd calibration image.

- calibrate:

  > perform calibrationStepsNumber steps of calibrationStep size starting and ending in symmetrical places relatively to initial position, both along X and Y, while measuring center of beam position.

  > Use these measurements to calculate axCoef and ayCoef.

  > Assumptions that are made: sin(x) ~= x x(y) axis of TEM parallel to x (y) axis of camera

- calibrationFactor:

    The calibration constant.

- beamShape:

    Time shape of the beam.

- xMinFit:

    Lower limit for the fit.

- xMaxFit:

    Upper limit for the fit.

- fitStatus:

    Error of fit procedure: 1-3 means good fit. See device documentation for further details.

- subtractPedestal:

    Subtract the pedestal, calculated from linear interpolation between first and last point.

- xPeak3:

    x-position of peak in the input image.

- xFWHM3:

    x-FWHM in the input image.

- pulseWidth:

    Duration of the pulse.

- ePulseWidth:

    Uncertainty of the pulse duration arising from fit procedure.

- switchToReady:

    Instructs the amplifier to go to ready state.

- switchOn:

    Instructs the amplifier to go to on state.

- switchOff:

    Instructs the amplifier to go to off state.

- closeShutter2:

    Instructs the amplifier to close Shutter 2.

- openShutter2:

    Instructs the amplifier to open Shutter 2.

- amphosIp:

    The IP address of the Amphos Control.

- amphosPort:

    The port of the Amphos Control.

- stateChanging:

    Laser is currently changing state.

- targetPower:

    Target laser power.

- chillerTemperature:

    Measured temperature of chiller.

- chillerFlow:

    Measured flow of chiller [l/min].

- chillerValvePosition:

    Measured valve position.

- shutter2IsOpen:

    Shutter2 State: False=closed True=open

- lambdaIsBusy:

    Lambda plate is moving.

- laserCurrent:

    Measured current of Amphos400.

- laserTemperature:

    Measured temperature of Amphos400.

- laserHumidity:

    Measured humidity of Amphos400.

- xfelCurrentCW1:

    Measured current of XFEL booster 1 (CW1).

- xfelCurrentCW2:

    Measured current of XFEL booster 1 (CW2).

- xfelCurrentQCW1:

    Measured current of XFEL booster 1 (QCW1).

- xfelCurrentQCW2:

    Measured current of XFEL booster 1 (QCW2).

- xfelCurrentQCW3:

    Measured current of XFEL booster 1 (QCW3).

- xfelCurrentQCW4:

    Measured current of XFEL booster 1 (QCW3).

- xfelTemperature:

    Measured temperature of XFEL booster 1.

- xfelHumidity:

    Measured humidity of XFEL booster 1.

- globalAlarmCondition:

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

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- log:

    Logging settings

- adc:

    fast ADC input device

- selectedAdcChannel:

    fast ADC channel in use for the loop

- maxPeakValue:

    Max absolute value for ADC peak. When peak is above this value step is applied

- tuneStage:

    motor controlling the stage to adjust laser path

- stageStep:

    value of stage tuning step size

- loopPeriod:

    Time interval for feedback cycle

- doublecheckWaitTime:

    after peak is above max, this time is waiting to check itagain, before applying step

- calibStepSize:

    Size of calibration step

- calibStepNum:

    Number of calibration steps

- calibAverageNum:

    number of peak values to be averaged for each calibration step

- reverseDirection:

    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

- conversionFactor:

    micrometers to femtoseconds conversion factor

- adcValueTimeout:

    if ADC value is not updated within this time, device goesin error state

- amphosAmpli:

    Karabo ID of Amphos Laser Amplifier

- triggerDelayDevice:

    Karabo ID of pplDelayControl device, used to read Pockels cell status

- moveToPlus:

    Move to +x position

- moveToMinus:

    Move to -x position

- moveToZero:

    Move to 0 position

- pathToProgramFiles:

    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

- correctionFile:

    The correction (.ct5) file, including path.

- useExternalTrigger:

    Use external trigger (if true) or auto-run (if false).

- startFromMinusX:

    Set loop initial position to -X

- jumpSpeed:

    The up/down jump speed [bits/ms].

- jumpAmplitude:

    The up/down jump amplitude [bits].

- delayTimePlus:

    Delay time, after moving to position +x.

- delayTimeMinus:

    Delay time, after moving to position -x.

- onTargetTolerance:

    The tolerance [bits] when checking that Galvo is on target position.

- onTargetPlus:

    Galvo is currently at +x position _and_ not moving.

- onTargetMinus:

    Galvo is currently at -x position _and_ not moving.

- laserOn:

    The value of the LASERON signal.

- digitalOut1:

    The value of the DIGITAL OUT1 signal.

- stopEventCode:

    Stop event code.

- galvoTemperature:

    Galvanometer scanner temperature.

- servoTemperature:

    Servo board temperature.

- agcVoltage:

    AGC voltage (PD supply voltage).

- dspCoreVoltage:

    DSP core supply voltage (1.8 V).

- dspIoVoltage:

    DSP IO voltage (3.3 V).

- analogSectVoltage:

    Analog section voltage (9 V).

- adConverterVoltage:

    AD converter supply voltage (5 V).

- galvoHeatingOut:

    Relative heating output of the corresponding galvanometer scanner heater.

- beamline:

    Beamline where to operate

- timingDevice:

    Device ID of PPL Delay Control Device

- galvoDevice:

    id of Galvo Controller

- downstreamSpectr1Device:

    Spectrometer 1 (FXE/SCS)

- upstreamSpectr1Device:

    Spectrometer 1 (SPB/SQS)

- currentExperiment:

    Current MASTER experiment (UPSTREAM or DOWNSTREAM)

- currentVersion:

    Current version

- correctionFactorMaster:

    Correction Factor Master

- correctionFactorSlave:

    Correction Factor Slave

- switchProgress:

    Switching Progress

- switchExperiment:

    Procedure to automatically swap between FXE and SPB delay control and Galvo settings

- on:

    Instructs the device to switch on

- off:

    Instructs device to switch off

- lastError:

    Last error message received. Time is set by front-end firmware.

- scpiTimeout:

    The SCPI communication timeout.

- baseFreq:

    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

- frontendReset:

    send reset command

- s7ack:

    acknowledge to s7 command

- s8ack:

    acknowledge to s8 command

- s9ack:

    acknowledge to s9 command

- laserEmission:

    True when laser ON, false when OFF

- generalStatus:

    True = OK, False = not OK

- temperatureStatus:

    True = OK, False = not OK

- delayBoardStatus:

    True = OK, False = not OK

- inputPin0Status:

    True = OK, False = not OK

- inputPin4Status:

    True = OK, False = not OK

- pd1Voltage:

    Photodiode 1 (TAB 2) voltage

- pd1VoltageAverage:

    Averaged PD1 (TAB 2) voltage

- pd2Voltage:

    Photodiode 2 (TAB 5) voltage

- pd2VoltageAverage:

    Averaged PD2 (TAB 5) voltage

- pd3Voltage:

    PD3 (SPCO 1) voltage

- pd3VoltageAverage:

    Averaged PD3 (SPCO 1) voltage

- pd4Voltage:

    PD4 (TAB 7) voltage

- pd4VoltageAverage:

    Averaged PD4 (TAB 7) voltage

- pd5Voltage:

    PD5 (SPCO2) voltage

- pd5VoltageAverage:

    Averaged PD5 (SPCO2) voltage

- pd6Voltage:

    PD6 voltage

- pd6VoltageAverage:

    Averaged PD6 voltage

- pd7Voltage:

    PD7 voltage

- pd7VoltageAverage:

    Averaged PD7 voltage

- pd8Voltage:

    PD8 voltage

- pd8VoltageAverage:

    Averaged PD8 voltage

- seederOutPower:

    photodiode 1

- xf1OutPower:

    Photodiode 7

- xf2OutPower:

    Photodiode 8

- seederStatus:

    True = OK, False = not OK

- generalSeederStatus:

    True = OK, False = not OK

- hiltiErrorStatus:

    True = OK, False = not OK

- remoteControl:

    if it is false we cannot see it

- regOnOff0:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- regOnOff1:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- setpAX0:

    Variable SetpAx[0] define the setpoint of the servo loop.

- setpAY0:

    Variable SetpAy[0] define the setpoint of the servo loop.

- sumA0:

    Sum signal of angle detector ‘A’

- sumB0:

    Sum signal of position detector ‘B’

- aX0:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY0:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX0:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY0:

    Variable By represents the measured position deviation in y direction from zero position

- rAX0:

    Regulator Output Ax

- rAY0:

    Regulator Output Ay

- rBX0:

    Regulator Output Bx

- rBY0:

    Regulator Output By

- rAXM0:

    Regulator Output AxM

- rAYM0:

    Regulator Output AyM

- rBXM0:

    Regulator Output BxM

- rBYM0:

    Regulator Output ByM

- setpAX1:

    Variable SetpAx[1] define the setpoint of the servo loop.

- setpAY1:

    Variable SetpAy[1] define the setpoint of the servo loop.

- sumA1:

    Sum signal of angle detector ‘A’

- sumB1:

    Sum signal of position detector ‘B’

- aX1:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY1:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX1:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY1:

    Variable By represents the measured position deviation in y direction from zero position

- rAX1:

    Regulator Output Ax

- rAY1:

    Regulator Output Ay

- rBX1:

    Regulator Output Bx

- rBY1:

    Regulator Output By

- rAXM1:

    Regulator Output AxM

- rAYM1:

    Regulator Output AyM

- rBXM1:

    Regulator Output BxM

- rBYM1:

    Regulator Output ByM

- stage1Id:

    Karabo device ID of first grating motor

- stage2Id:

    Karabo device ID of first grating motor

- tunnel:

    Location where doocs_device is deployed (e.g. ‘SASE1’)

- labx2MName:

    DOOCS name of X2 Master doocs_device

- labx2SName:

    DOOCS name of X2 Slave doocs_device

- timingShifterName:

    DOOCS name of Phase Shifter doocs_device

- manualTuning:

    Manual Tuning Enable

- useShifter:

    Set to True if optical synchronization is available

- midTsValue:

    Mid Value of Phase Shifter

- maxTsDelay:

    Maximum delay to add/subtract to phase shifter position

- maxTsJitter:

    Maximum allowed jitter

- laserOpModeList:

    Select Laser Op Mode

- activeLaserOpMode:

    Active Op laser Mode

- laserOpModeListApply:

    Apply Laser Operation Mode

- dmBCCAuto:

    Automatic loop on/off

- pCellState:

    Status of Pockels Cell, True = On

- pCellOn:

    Set Pockels cell on

- pCellOff:

    Set Pockels cell off

- AOMState:

    Status of AOM, True = On

- AOMOn:

    Set AOM on

- AOMOff:

    Set AOM off

- maxAllowedPcPhase:

    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

- mPCCLKPhase:

    Master PC Phase

- mSWPCCLKPhase:

    Master SW PC Phase

- mBurstWidth:

    Master burst width [us]

- mBurstWidthApply:

    Apply m Burst Width

- mBurstStart:

    Begining of the bursts the slave burst is +50ms)

- mBurstStartsms:

    Master burst starts pos. [us]

- sBurstStartsms:

    Sleve burst starts pos. [us]

- smBurstDiff:

    Different between muster and slave burst positione

- sPCCLKPhase:

    Master PC Phase

- sSWPCCLKPhase:

    Slave software PC PHase

- sBurstWidth:

    Slave burst width [us]

- sBurstWidthApply:

    Apply S Burst width

- delayBPMaster:

    Current delay of the master bunch pattern in clock unit (machine)

- delayBPMasterP:

    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterM:

    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterP24:

    Increment Master Bunch Pattern delay by 24 clock unit

- delayBPMasterM24:

    Decrement Master Bunch Pattern delay by 24 clock unit

- delayBPSlave:

    Current delay of the slave bunch pattern in clock unit (machine)

- delayBPSlaveP:

    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveM:

    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveP24:

    Increment Slave Bunch Pattern delay by 24 clock unit

- delayBPSlaveM24:

    Decrement Slave Bunch Pattern delay by 24 clock unit

- masterExpPattern:

    Select pattern for master experiment

- slaveExpPattern:

    Select pattern for slave experiment

- currentLaserPatterns:

    Current Laser Patterns

- currentMasterLaserPattern:

    Current Master Laser Patterns

- currentSlaveLaserPattern:

    Current Slave Laser Patterns

- currentSlaveLaserPatternN:

    Current Slave Laser Pattern

- fineDelayMaxCounts:

    Fine delay - maximum count number

- fineDelayValue:

    fine delay count value

- fineDelayValueT:

    fine delay time value

- fineDelayP:

    Increment fine delay

- fineDelayM:

    Decrement fine delay

- fineDelay9nsChange:

    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

- fineDelay9ns:

    Change Fine Delay by 9 ns

- minTsPosition:

    Minimum Timing Shifter Delay

- maxTsPosition:

    Maximum Timing Shifter Delay

- currentTsPosition:

    current value of time shifter position

- requestedTsDelay:

    Delay to apply to the phase shifter

- DelayTsChange:

    Change phase shifter by requested value

- relAbsolutTsPos:

    True for relative, False for absolute

- stopPsChange:

    Abort phase shift change

- opticalSynch:

    Display status of optical synchronization

- opticalSynchLock:

    Display lock status of optical synchronization

- opticalSynchJitter:

    Display status of optical synchronization jitter

- opticalSynchMode:

    Optical synch. mode (RF / Optical)

- setOpticalDelay:

    Delay to apply to optical delay line

- applyOpticalDelay:

    change the optical delay by requeste value

- currentOpticalDelay:

    Current position of optical delay

- relAbsolutDelayLine:

    True for relative, False for absolute

- TsJitter:

    Optical Synchronization Jitter

- triggerFE_DOWNSTREAM:

    Current trigger delay FE DOWNSTREAM

- triggerFE_UPSTREAM:

    Current trigger delay FE UPSTREAM

- getCurrentHardwareStatus:

    Read configuration from hardware

- lastShiftDelay:

    FE delay value from the prevoius shift

- setLastShiftDelay:

    Bring the delay to position from the previus shift

- clearLock:

    In case of STATE == changing bring the state to Normal

- mPCCLKPhaseSetValue:

    Master PC CLK Phase Value

- sPCCLKPhaseSetValue:

    Slave PC CLK Phase Value

- delayBPMasterSetValue:

    Master BP delay Value

- delayBPSlaveSetValue:

    Slave BP delay Value

- resetError:

    Reset error state

- upstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for upstream instrument

- downstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for downstream instrument

- shiftChange:

    Swaps MASTER and SLAVE properties between upstream and downstream instrument

- isOxcActive:

    Status of optical lock (True: OPTICAL mode, False: RF mode)

- requestedDelay:

    Relative delay to be applied by delay change (Trigger Position)

- delayChange:

    Change delay value by applying (relative) offset

- mPCCLKPhaseP:

    Increment PC master Phase

- mPCCLKPhaseM:

    Decrement PC master Phase

- sPCCLKPhaseP:

    Increment slave PC Phase

- sPCCLKPhaseM:

    Decrement slave PC phase

- savemSWPCCLKPhase:

    Save new software phase value for PCm

- savesSWPCCLKPhase:

    Save new software phase value for PCs

- mBurstStartApply:

    Apply Burst Start Pos

- takemidTsValue:

    Take mid value of phase shifter

- logBoardsStatus:

    JSON string describing master and slave board settings.Usually updated when user actions are taken

- logFineDelay:

    JSON string describing fine delay settings.Usually updated when user actions are taken

- imgprocDevice:

    Device ID of image processor used for feedback

- temDevice:

    id of tem device

- temChannel:

    TEM channel to be controlled

- xCoefWeight:

    weight of X coefficient

- yCoefWeight:

    weight of Y coefficient

- axCoefOld:

    Value of Ax Coefficient saved prior to calibration

- ayCoefOld:

    Value of Ay Coefficient saved prior to calibration

- xBeamCenterTarget:

    desired value for Beam Center X coordinate

- yBeamCenterTarget:

    desired value for Beam Center Y coordinate

- beamCenterMaxDisplacement:

    maximum allowed displacement for Center of Mass from target position

- maxTemDrift:

    Maximum value allowed for TEM drift

- averageNumber:

    number of values of beam center coordinates to average

- timeoutImageProcessorValues:

    Time to wait before going in error when values from image processor are not updating

- imageSettlementTime:

    Time to wait before reading beam center coordinates aftermoving TEM setpoint

- calibrationStep:

    TEM setpoint step size for calibration

- calibrationStepsNumber:

    Number of TEM calibration steps

- maxTimeNotRegulating:

    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

- setCurrentPosAsTarget:

    Set current beam position as target

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

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

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

###### TRACEYCOMP_FXE_2

Instance id: | LA1_LAS_PPL/DCTRL/TRACEYCOMP_FXE_2
Host: | exflcon14n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

Device Schema Description

- _serverId_:

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

- _deviceId_:

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

- _connection_:

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

- visibility:

    Configures who is allowed to see this device at all

- deviceId:

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

- classId:

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

- classVersion:

    The version of the class of this device defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- alarmCondition:

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

- lastCommand:

    The last slot called.

- archive:

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

- useTimeserver:

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

- progress:

    The progress of the current action

- heartbeatInterval:

    The heartbeat interval

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

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

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

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

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

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

- epsilon:

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

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

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

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

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

- maxStateUpdateRate:

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

- noisyStateUpdateRateValue:

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

- isStateUpdateNoisy:

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

- reset:

    Resets the PLC hardware

- enableInterlockedSlots:

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

- disableInterlockedSlots:

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

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

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

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

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

- readHardware:

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

- force:

    ???

- trigger:

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

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- value:

    Analog input of ADC.

- scale:

    Scaling factor for analog value.

- offset:

    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!

- start:

    Instructs device to go to started state

- stop:

    Instructs device to go to stopped state

- resetADC:

    Reset ADC’s of FPGA in case of constant line, No signal

- resetDDR2:

    Resets DDR2 in case of constant line, No signal

- deviceFile:

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

- mapDirectory:

    Folder where all xml mapping files are located.

- numberRawSamples:

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

- delay:

    Delay between calibration images.

- skipSamples:

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

- triggerTime:

    Time between Triggers

- triggerTimeStat:

    Histogram of time between Triggers

- trainId:

    Current train ID as read from the FPGA

- config:

    Board related configuration parameters.

- dacNode:

    Set up DAC parameters

- channel_0:

    This is a channel of bunch of other parameters

- channel_1:

    This is a channel of bunch of other parameters

- channel_2:

    This is a channel of bunch of other parameters

- channel_3:

    This is a channel of bunch of other parameters

- channel_4:

    This is a channel of bunch of other parameters

- channel_5:

    This is a channel of bunch of other parameters

- channel_6:

    This is a channel of bunch of other parameters

- channel_7:

    This is a channel of bunch of other parameters

- channel_8:

    This is a channel of bunch of other parameters

- channel_9:

    This is a channel of bunch of other parameters

- semiRawValue:

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

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- timeServerId:

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

- Logger:

    Logging settings

- sendCommand:

    Send command to the instrument.

- replyToCommand:

    Reply to the command send to the instrument.

- gotoErrorOnPollFailure:

    Instrument will go to error if poll fails for all properties.

- autoConnect:

    Set True to automatically connect to device.

- pollingInterval:

    The interval for polling the instrument.

- enableHeartbeat:

    Enable Heartbeat

- heartbeatCommand:

    Text to send as heartbeat

- heartbeatReply:

    Heartbeat reply text

- heartbeatPeriod:

    Heartbeat period

- heartbeatTime:

    Last heartbeat time

- pollingTimeTaken:

    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

- pollNow:

    Poll instrument now!

- _connect_:

    Connects to the device

- disconnect:

    Disconnects from the device

- handshake:

    Set the state of the message roundtrip handshaking.

- baudRate:

    Set the transmit and receive baud rates on the RS-232 port.

- errorCount:

    The number of error records in the queue.

- measureType:

    Set the meter measurement mode (energy or power).

- statisticsMode:

    Set the statistics processing mode (on or off).

- variableDecimation:

    Set the pulse decimation rate (1-99999).

- apertureDiameter:

    Set the aperture diameter.

- wavelength:

    Set the current wavelength.

- gainCompensation:

    Enables or disables the gain compensation.

- gainFactor:

    Set the gain compensation factor.

- range:

    Set the measurement range (maximum expected measurement).

- batchSize:

    Set the statistics batch size.

- restartMode:

    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

- statStart:

    Terminates the current statistical batch and start a new one.

- statStop:

    Terminates the current statistical batch.

- triggerSource:

    Selects the trigger source (INTernal / EXTernal).

- triggerLevel:

    Set the trigger level (no effect when external trigger is selected).

- triggerSlope:

    Selects the external trigger edge (POSitive / NEGative).

- sequenceId:

    Set the sequence ID.

- triggerBus:

    Selects the trigger bus participation mode.

- itemSelect:

    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

- statItemSelect:

    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

- serialNumber:

    The serial number string.

- partNumber:

    The part number.

- modelName:

    The Model Name.

- calibrationDate:

    The calibration date.

- manifacturingDate:

    The manifacturing date.

- defaultWavelength:

    The default wavelength.

- measurementRefreshRate:

    The refresh rate of measurements.

- measurement:

    Last measurement.

- idType:

    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

- cameraId:

    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

- packetDelay:

    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

- autoPacketSize:

    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

- packetSize:

    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

- exposureTime:

    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

- triggerMode:

    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

- triggerActivation:

    This enumeration sets the signal transition needed to activate the selected trigger.

- autoGain:

    Configures automatic gain feature.

- gain:

    Sets the gain of the ADC converter.

- acquisitionMode:

    This property sets the image acquisition mode.

- frameCount:

    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

- xPeak1:

    x-position of peak in first calibration image.

- xFWHM1:

    x-FWHM in first calibration image.

- xPeak2:

    x-position of peak in second calibration image.

- xFWHM2:

    x-FWHM in second calibration image.

- delayUnit:

    Unit of the delay between calibration images.

- useAsCalibrationImage1:

    Use the current image as 1st calibration image.

- useAsCalibrationImage2:

    Use the current image as 2nd calibration image.

- calibrate:

  > perform calibrationStepsNumber steps of calibrationStep size starting and ending in symmetrical places relatively to initial position, both along X and Y, while measuring center of beam position.

  > Use these measurements to calculate axCoef and ayCoef.

  > Assumptions that are made: sin(x) ~= x x(y) axis of TEM parallel to x (y) axis of camera

- calibrationFactor:

    The calibration constant.

- beamShape:

    Time shape of the beam.

- xMinFit:

    Lower limit for the fit.

- xMaxFit:

    Upper limit for the fit.

- fitStatus:

    Error of fit procedure: 1-3 means good fit. See device documentation for further details.

- subtractPedestal:

    Subtract the pedestal, calculated from linear interpolation between first and last point.

- xPeak3:

    x-position of peak in the input image.

- xFWHM3:

    x-FWHM in the input image.

- pulseWidth:

    Duration of the pulse.

- ePulseWidth:

    Uncertainty of the pulse duration arising from fit procedure.

- switchToReady:

    Instructs the amplifier to go to ready state.

- switchOn:

    Instructs the amplifier to go to on state.

- switchOff:

    Instructs the amplifier to go to off state.

- closeShutter2:

    Instructs the amplifier to close Shutter 2.

- openShutter2:

    Instructs the amplifier to open Shutter 2.

- amphosIp:

    The IP address of the Amphos Control.

- amphosPort:

    The port of the Amphos Control.

- stateChanging:

    Laser is currently changing state.

- targetPower:

    Target laser power.

- chillerTemperature:

    Measured temperature of chiller.

- chillerFlow:

    Measured flow of chiller [l/min].

- chillerValvePosition:

    Measured valve position.

- shutter2IsOpen:

    Shutter2 State: False=closed True=open

- lambdaIsBusy:

    Lambda plate is moving.

- laserCurrent:

    Measured current of Amphos400.

- laserTemperature:

    Measured temperature of Amphos400.

- laserHumidity:

    Measured humidity of Amphos400.

- xfelCurrentCW1:

    Measured current of XFEL booster 1 (CW1).

- xfelCurrentCW2:

    Measured current of XFEL booster 1 (CW2).

- xfelCurrentQCW1:

    Measured current of XFEL booster 1 (QCW1).

- xfelCurrentQCW2:

    Measured current of XFEL booster 1 (QCW2).

- xfelCurrentQCW3:

    Measured current of XFEL booster 1 (QCW3).

- xfelCurrentQCW4:

    Measured current of XFEL booster 1 (QCW3).

- xfelTemperature:

    Measured temperature of XFEL booster 1.

- xfelHumidity:

    Measured humidity of XFEL booster 1.

- globalAlarmCondition:

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

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- log:

    Logging settings

- adc:

    fast ADC input device

- selectedAdcChannel:

    fast ADC channel in use for the loop

- maxPeakValue:

    Max absolute value for ADC peak. When peak is above this value step is applied

- tuneStage:

    motor controlling the stage to adjust laser path

- stageStep:

    value of stage tuning step size

- loopPeriod:

    Time interval for feedback cycle

- doublecheckWaitTime:

    after peak is above max, this time is waiting to check itagain, before applying step

- calibStepSize:

    Size of calibration step

- calibStepNum:

    Number of calibration steps

- calibAverageNum:

    number of peak values to be averaged for each calibration step

- reverseDirection:

    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

- conversionFactor:

    micrometers to femtoseconds conversion factor

- adcValueTimeout:

    if ADC value is not updated within this time, device goesin error state

- amphosAmpli:

    Karabo ID of Amphos Laser Amplifier

- triggerDelayDevice:

    Karabo ID of pplDelayControl device, used to read Pockels cell status

- moveToPlus:

    Move to +x position

- moveToMinus:

    Move to -x position

- moveToZero:

    Move to 0 position

- pathToProgramFiles:

    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

- correctionFile:

    The correction (.ct5) file, including path.

- useExternalTrigger:

    Use external trigger (if true) or auto-run (if false).

- startFromMinusX:

    Set loop initial position to -X

- jumpSpeed:

    The up/down jump speed [bits/ms].

- jumpAmplitude:

    The up/down jump amplitude [bits].

- delayTimePlus:

    Delay time, after moving to position +x.

- delayTimeMinus:

    Delay time, after moving to position -x.

- onTargetTolerance:

    The tolerance [bits] when checking that Galvo is on target position.

- onTargetPlus:

    Galvo is currently at +x position _and_ not moving.

- onTargetMinus:

    Galvo is currently at -x position _and_ not moving.

- laserOn:

    The value of the LASERON signal.

- digitalOut1:

    The value of the DIGITAL OUT1 signal.

- stopEventCode:

    Stop event code.

- galvoTemperature:

    Galvanometer scanner temperature.

- servoTemperature:

    Servo board temperature.

- agcVoltage:

    AGC voltage (PD supply voltage).

- dspCoreVoltage:

    DSP core supply voltage (1.8 V).

- dspIoVoltage:

    DSP IO voltage (3.3 V).

- analogSectVoltage:

    Analog section voltage (9 V).

- adConverterVoltage:

    AD converter supply voltage (5 V).

- galvoHeatingOut:

    Relative heating output of the corresponding galvanometer scanner heater.

- beamline:

    Beamline where to operate

- timingDevice:

    Device ID of PPL Delay Control Device

- galvoDevice:

    id of Galvo Controller

- downstreamSpectr1Device:

    Spectrometer 1 (FXE/SCS)

- upstreamSpectr1Device:

    Spectrometer 1 (SPB/SQS)

- currentExperiment:

    Current MASTER experiment (UPSTREAM or DOWNSTREAM)

- currentVersion:

    Current version

- correctionFactorMaster:

    Correction Factor Master

- correctionFactorSlave:

    Correction Factor Slave

- switchProgress:

    Switching Progress

- switchExperiment:

    Procedure to automatically swap between FXE and SPB delay control and Galvo settings

- on:

    Instructs the device to switch on

- off:

    Instructs device to switch off

- lastError:

    Last error message received. Time is set by front-end firmware.

- scpiTimeout:

    The SCPI communication timeout.

- baseFreq:

    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

- frontendReset:

    send reset command

- s7ack:

    acknowledge to s7 command

- s8ack:

    acknowledge to s8 command

- s9ack:

    acknowledge to s9 command

- laserEmission:

    True when laser ON, false when OFF

- generalStatus:

    True = OK, False = not OK

- temperatureStatus:

    True = OK, False = not OK

- delayBoardStatus:

    True = OK, False = not OK

- inputPin0Status:

    True = OK, False = not OK

- inputPin4Status:

    True = OK, False = not OK

- pd1Voltage:

    Photodiode 1 (TAB 2) voltage

- pd1VoltageAverage:

    Averaged PD1 (TAB 2) voltage

- pd2Voltage:

    Photodiode 2 (TAB 5) voltage

- pd2VoltageAverage:

    Averaged PD2 (TAB 5) voltage

- pd3Voltage:

    PD3 (SPCO 1) voltage

- pd3VoltageAverage:

    Averaged PD3 (SPCO 1) voltage

- pd4Voltage:

    PD4 (TAB 7) voltage

- pd4VoltageAverage:

    Averaged PD4 (TAB 7) voltage

- pd5Voltage:

    PD5 (SPCO2) voltage

- pd5VoltageAverage:

    Averaged PD5 (SPCO2) voltage

- pd6Voltage:

    PD6 voltage

- pd6VoltageAverage:

    Averaged PD6 voltage

- pd7Voltage:

    PD7 voltage

- pd7VoltageAverage:

    Averaged PD7 voltage

- pd8Voltage:

    PD8 voltage

- pd8VoltageAverage:

    Averaged PD8 voltage

- seederOutPower:

    photodiode 1

- xf1OutPower:

    Photodiode 7

- xf2OutPower:

    Photodiode 8

- seederStatus:

    True = OK, False = not OK

- generalSeederStatus:

    True = OK, False = not OK

- hiltiErrorStatus:

    True = OK, False = not OK

- remoteControl:

    if it is false we cannot see it

- regOnOff0:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- regOnOff1:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- setpAX0:

    Variable SetpAx[0] define the setpoint of the servo loop.

- setpAY0:

    Variable SetpAy[0] define the setpoint of the servo loop.

- sumA0:

    Sum signal of angle detector ‘A’

- sumB0:

    Sum signal of position detector ‘B’

- aX0:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY0:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX0:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY0:

    Variable By represents the measured position deviation in y direction from zero position

- rAX0:

    Regulator Output Ax

- rAY0:

    Regulator Output Ay

- rBX0:

    Regulator Output Bx

- rBY0:

    Regulator Output By

- rAXM0:

    Regulator Output AxM

- rAYM0:

    Regulator Output AyM

- rBXM0:

    Regulator Output BxM

- rBYM0:

    Regulator Output ByM

- setpAX1:

    Variable SetpAx[1] define the setpoint of the servo loop.

- setpAY1:

    Variable SetpAy[1] define the setpoint of the servo loop.

- sumA1:

    Sum signal of angle detector ‘A’

- sumB1:

    Sum signal of position detector ‘B’

- aX1:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY1:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX1:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY1:

    Variable By represents the measured position deviation in y direction from zero position

- rAX1:

    Regulator Output Ax

- rAY1:

    Regulator Output Ay

- rBX1:

    Regulator Output Bx

- rBY1:

    Regulator Output By

- rAXM1:

    Regulator Output AxM

- rAYM1:

    Regulator Output AyM

- rBXM1:

    Regulator Output BxM

- rBYM1:

    Regulator Output ByM

- stage1Id:

    Karabo device ID of first grating motor

- stage2Id:

    Karabo device ID of first grating motor

- tunnel:

    Location where doocs_device is deployed (e.g. ‘SASE1’)

- labx2MName:

    DOOCS name of X2 Master doocs_device

- labx2SName:

    DOOCS name of X2 Slave doocs_device

- timingShifterName:

    DOOCS name of Phase Shifter doocs_device

- manualTuning:

    Manual Tuning Enable

- useShifter:

    Set to True if optical synchronization is available

- midTsValue:

    Mid Value of Phase Shifter

- maxTsDelay:

    Maximum delay to add/subtract to phase shifter position

- maxTsJitter:

    Maximum allowed jitter

- laserOpModeList:

    Select Laser Op Mode

- activeLaserOpMode:

    Active Op laser Mode

- laserOpModeListApply:

    Apply Laser Operation Mode

- dmBCCAuto:

    Automatic loop on/off

- pCellState:

    Status of Pockels Cell, True = On

- pCellOn:

    Set Pockels cell on

- pCellOff:

    Set Pockels cell off

- AOMState:

    Status of AOM, True = On

- AOMOn:

    Set AOM on

- AOMOff:

    Set AOM off

- maxAllowedPcPhase:

    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

- mPCCLKPhase:

    Master PC Phase

- mSWPCCLKPhase:

    Master SW PC Phase

- mBurstWidth:

    Master burst width [us]

- mBurstWidthApply:

    Apply m Burst Width

- mBurstStart:

    Begining of the bursts the slave burst is +50ms)

- mBurstStartsms:

    Master burst starts pos. [us]

- sBurstStartsms:

    Sleve burst starts pos. [us]

- smBurstDiff:

    Different between muster and slave burst positione

- sPCCLKPhase:

    Master PC Phase

- sSWPCCLKPhase:

    Slave software PC PHase

- sBurstWidth:

    Slave burst width [us]

- sBurstWidthApply:

    Apply S Burst width

- delayBPMaster:

    Current delay of the master bunch pattern in clock unit (machine)

- delayBPMasterP:

    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterM:

    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterP24:

    Increment Master Bunch Pattern delay by 24 clock unit

- delayBPMasterM24:

    Decrement Master Bunch Pattern delay by 24 clock unit

- delayBPSlave:

    Current delay of the slave bunch pattern in clock unit (machine)

- delayBPSlaveP:

    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveM:

    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveP24:

    Increment Slave Bunch Pattern delay by 24 clock unit

- delayBPSlaveM24:

    Decrement Slave Bunch Pattern delay by 24 clock unit

- masterExpPattern:

    Select pattern for master experiment

- slaveExpPattern:

    Select pattern for slave experiment

- currentLaserPatterns:

    Current Laser Patterns

- currentMasterLaserPattern:

    Current Master Laser Patterns

- currentSlaveLaserPattern:

    Current Slave Laser Patterns

- currentSlaveLaserPatternN:

    Current Slave Laser Pattern

- fineDelayMaxCounts:

    Fine delay - maximum count number

- fineDelayValue:

    fine delay count value

- fineDelayValueT:

    fine delay time value

- fineDelayP:

    Increment fine delay

- fineDelayM:

    Decrement fine delay

- fineDelay9nsChange:

    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

- fineDelay9ns:

    Change Fine Delay by 9 ns

- minTsPosition:

    Minimum Timing Shifter Delay

- maxTsPosition:

    Maximum Timing Shifter Delay

- currentTsPosition:

    current value of time shifter position

- requestedTsDelay:

    Delay to apply to the phase shifter

- DelayTsChange:

    Change phase shifter by requested value

- relAbsolutTsPos:

    True for relative, False for absolute

- stopPsChange:

    Abort phase shift change

- opticalSynch:

    Display status of optical synchronization

- opticalSynchLock:

    Display lock status of optical synchronization

- opticalSynchJitter:

    Display status of optical synchronization jitter

- opticalSynchMode:

    Optical synch. mode (RF / Optical)

- setOpticalDelay:

    Delay to apply to optical delay line

- applyOpticalDelay:

    change the optical delay by requeste value

- currentOpticalDelay:

    Current position of optical delay

- relAbsolutDelayLine:

    True for relative, False for absolute

- TsJitter:

    Optical Synchronization Jitter

- triggerFE_DOWNSTREAM:

    Current trigger delay FE DOWNSTREAM

- triggerFE_UPSTREAM:

    Current trigger delay FE UPSTREAM

- getCurrentHardwareStatus:

    Read configuration from hardware

- lastShiftDelay:

    FE delay value from the prevoius shift

- setLastShiftDelay:

    Bring the delay to position from the previus shift

- clearLock:

    In case of STATE == changing bring the state to Normal

- mPCCLKPhaseSetValue:

    Master PC CLK Phase Value

- sPCCLKPhaseSetValue:

    Slave PC CLK Phase Value

- delayBPMasterSetValue:

    Master BP delay Value

- delayBPSlaveSetValue:

    Slave BP delay Value

- resetError:

    Reset error state

- upstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for upstream instrument

- downstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for downstream instrument

- shiftChange:

    Swaps MASTER and SLAVE properties between upstream and downstream instrument

- isOxcActive:

    Status of optical lock (True: OPTICAL mode, False: RF mode)

- requestedDelay:

    Relative delay to be applied by delay change (Trigger Position)

- delayChange:

    Change delay value by applying (relative) offset

- mPCCLKPhaseP:

    Increment PC master Phase

- mPCCLKPhaseM:

    Decrement PC master Phase

- sPCCLKPhaseP:

    Increment slave PC Phase

- sPCCLKPhaseM:

    Decrement slave PC phase

- savemSWPCCLKPhase:

    Save new software phase value for PCm

- savesSWPCCLKPhase:

    Save new software phase value for PCs

- mBurstStartApply:

    Apply Burst Start Pos

- takemidTsValue:

    Take mid value of phase shifter

- logBoardsStatus:

    JSON string describing master and slave board settings.Usually updated when user actions are taken

- logFineDelay:

    JSON string describing fine delay settings.Usually updated when user actions are taken

- imgprocDevice:

    Device ID of image processor used for feedback

- temDevice:

    id of tem device

- temChannel:

    TEM channel to be controlled

- xCoefWeight:

    weight of X coefficient

- yCoefWeight:

    weight of Y coefficient

- axCoefOld:

    Value of Ax Coefficient saved prior to calibration

- ayCoefOld:

    Value of Ay Coefficient saved prior to calibration

- xBeamCenterTarget:

    desired value for Beam Center X coordinate

- yBeamCenterTarget:

    desired value for Beam Center Y coordinate

- beamCenterMaxDisplacement:

    maximum allowed displacement for Center of Mass from target position

- maxTemDrift:

    Maximum value allowed for TEM drift

- averageNumber:

    number of values of beam center coordinates to average

- timeoutImageProcessorValues:

    Time to wait before going in error when values from image processor are not updating

- imageSettlementTime:

    Time to wait before reading beam center coordinates aftermoving TEM setpoint

- calibrationStep:

    TEM setpoint step size for calibration

- calibrationStepsNumber:

    Number of TEM calibration steps

- maxTimeNotRegulating:

    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

- setCurrentPosAsTarget:

    Set current beam position as target

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

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

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

###### TRACEYCOMP_SPB_1

Instance id: | LA1_LAS_PPL/DCTRL/TRACEYCOMP_SPB_1
Host: | exflcon14n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

Device Schema Description

- _serverId_:

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

- _deviceId_:

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

- _connection_:

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

- visibility:

    Configures who is allowed to see this device at all

- deviceId:

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

- classId:

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

- classVersion:

    The version of the class of this device defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- alarmCondition:

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

- lastCommand:

    The last slot called.

- archive:

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

- useTimeserver:

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

- progress:

    The progress of the current action

- heartbeatInterval:

    The heartbeat interval

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

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

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

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

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

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

- epsilon:

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

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

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

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

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

- maxStateUpdateRate:

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

- noisyStateUpdateRateValue:

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

- isStateUpdateNoisy:

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

- reset:

    Resets the PLC hardware

- enableInterlockedSlots:

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

- disableInterlockedSlots:

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

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

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

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

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

- readHardware:

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

- force:

    ???

- trigger:

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

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- value:

    Analog input of ADC.

- scale:

    Scaling factor for analog value.

- offset:

    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!

- start:

    Instructs device to go to started state

- stop:

    Instructs device to go to stopped state

- resetADC:

    Reset ADC’s of FPGA in case of constant line, No signal

- resetDDR2:

    Resets DDR2 in case of constant line, No signal

- deviceFile:

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

- mapDirectory:

    Folder where all xml mapping files are located.

- numberRawSamples:

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

- delay:

    Delay between calibration images.

- skipSamples:

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

- triggerTime:

    Time between Triggers

- triggerTimeStat:

    Histogram of time between Triggers

- trainId:

    Current train ID as read from the FPGA

- config:

    Board related configuration parameters.

- dacNode:

    Set up DAC parameters

- channel_0:

    This is a channel of bunch of other parameters

- channel_1:

    This is a channel of bunch of other parameters

- channel_2:

    This is a channel of bunch of other parameters

- channel_3:

    This is a channel of bunch of other parameters

- channel_4:

    This is a channel of bunch of other parameters

- channel_5:

    This is a channel of bunch of other parameters

- channel_6:

    This is a channel of bunch of other parameters

- channel_7:

    This is a channel of bunch of other parameters

- channel_8:

    This is a channel of bunch of other parameters

- channel_9:

    This is a channel of bunch of other parameters

- semiRawValue:

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

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- timeServerId:

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

- Logger:

    Logging settings

- sendCommand:

    Send command to the instrument.

- replyToCommand:

    Reply to the command send to the instrument.

- gotoErrorOnPollFailure:

    Instrument will go to error if poll fails for all properties.

- autoConnect:

    Set True to automatically connect to device.

- pollingInterval:

    The interval for polling the instrument.

- enableHeartbeat:

    Enable Heartbeat

- heartbeatCommand:

    Text to send as heartbeat

- heartbeatReply:

    Heartbeat reply text

- heartbeatPeriod:

    Heartbeat period

- heartbeatTime:

    Last heartbeat time

- pollingTimeTaken:

    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

- pollNow:

    Poll instrument now!

- _connect_:

    Connects to the device

- disconnect:

    Disconnects from the device

- handshake:

    Set the state of the message roundtrip handshaking.

- baudRate:

    Set the transmit and receive baud rates on the RS-232 port.

- errorCount:

    The number of error records in the queue.

- measureType:

    Set the meter measurement mode (energy or power).

- statisticsMode:

    Set the statistics processing mode (on or off).

- variableDecimation:

    Set the pulse decimation rate (1-99999).

- apertureDiameter:

    Set the aperture diameter.

- wavelength:

    Set the current wavelength.

- gainCompensation:

    Enables or disables the gain compensation.

- gainFactor:

    Set the gain compensation factor.

- range:

    Set the measurement range (maximum expected measurement).

- batchSize:

    Set the statistics batch size.

- restartMode:

    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

- statStart:

    Terminates the current statistical batch and start a new one.

- statStop:

    Terminates the current statistical batch.

- triggerSource:

    Selects the trigger source (INTernal / EXTernal).

- triggerLevel:

    Set the trigger level (no effect when external trigger is selected).

- triggerSlope:

    Selects the external trigger edge (POSitive / NEGative).

- sequenceId:

    Set the sequence ID.

- triggerBus:

    Selects the trigger bus participation mode.

- itemSelect:

    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

- statItemSelect:

    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

- serialNumber:

    The serial number string.

- partNumber:

    The part number.

- modelName:

    The Model Name.

- calibrationDate:

    The calibration date.

- manifacturingDate:

    The manifacturing date.

- defaultWavelength:

    The default wavelength.

- measurementRefreshRate:

    The refresh rate of measurements.

- measurement:

    Last measurement.

- idType:

    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

- cameraId:

    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

- packetDelay:

    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

- autoPacketSize:

    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

- packetSize:

    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

- exposureTime:

    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

- triggerMode:

    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

- triggerActivation:

    This enumeration sets the signal transition needed to activate the selected trigger.

- autoGain:

    Configures automatic gain feature.

- gain:

    Sets the gain of the ADC converter.

- acquisitionMode:

    This property sets the image acquisition mode.

- frameCount:

    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

- xPeak1:

    x-position of peak in first calibration image.

- xFWHM1:

    x-FWHM in first calibration image.

- xPeak2:

    x-position of peak in second calibration image.

- xFWHM2:

    x-FWHM in second calibration image.

- delayUnit:

    Unit of the delay between calibration images.

- useAsCalibrationImage1:

    Use the current image as 1st calibration image.

- useAsCalibrationImage2:

    Use the current image as 2nd calibration image.

- calibrate:

  > perform calibrationStepsNumber steps of calibrationStep size starting and ending in symmetrical places relatively to initial position, both along X and Y, while measuring center of beam position.

  > Use these measurements to calculate axCoef and ayCoef.

  > Assumptions that are made: sin(x) ~= x x(y) axis of TEM parallel to x (y) axis of camera

- calibrationFactor:

    The calibration constant.

- beamShape:

    Time shape of the beam.

- xMinFit:

    Lower limit for the fit.

- xMaxFit:

    Upper limit for the fit.

- fitStatus:

    Error of fit procedure: 1-3 means good fit. See device documentation for further details.

- subtractPedestal:

    Subtract the pedestal, calculated from linear interpolation between first and last point.

- xPeak3:

    x-position of peak in the input image.

- xFWHM3:

    x-FWHM in the input image.

- pulseWidth:

    Duration of the pulse.

- ePulseWidth:

    Uncertainty of the pulse duration arising from fit procedure.

- switchToReady:

    Instructs the amplifier to go to ready state.

- switchOn:

    Instructs the amplifier to go to on state.

- switchOff:

    Instructs the amplifier to go to off state.

- closeShutter2:

    Instructs the amplifier to close Shutter 2.

- openShutter2:

    Instructs the amplifier to open Shutter 2.

- amphosIp:

    The IP address of the Amphos Control.

- amphosPort:

    The port of the Amphos Control.

- stateChanging:

    Laser is currently changing state.

- targetPower:

    Target laser power.

- chillerTemperature:

    Measured temperature of chiller.

- chillerFlow:

    Measured flow of chiller [l/min].

- chillerValvePosition:

    Measured valve position.

- shutter2IsOpen:

    Shutter2 State: False=closed True=open

- lambdaIsBusy:

    Lambda plate is moving.

- laserCurrent:

    Measured current of Amphos400.

- laserTemperature:

    Measured temperature of Amphos400.

- laserHumidity:

    Measured humidity of Amphos400.

- xfelCurrentCW1:

    Measured current of XFEL booster 1 (CW1).

- xfelCurrentCW2:

    Measured current of XFEL booster 1 (CW2).

- xfelCurrentQCW1:

    Measured current of XFEL booster 1 (QCW1).

- xfelCurrentQCW2:

    Measured current of XFEL booster 1 (QCW2).

- xfelCurrentQCW3:

    Measured current of XFEL booster 1 (QCW3).

- xfelCurrentQCW4:

    Measured current of XFEL booster 1 (QCW3).

- xfelTemperature:

    Measured temperature of XFEL booster 1.

- xfelHumidity:

    Measured humidity of XFEL booster 1.

- globalAlarmCondition:

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

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- log:

    Logging settings

- adc:

    fast ADC input device

- selectedAdcChannel:

    fast ADC channel in use for the loop

- maxPeakValue:

    Max absolute value for ADC peak. When peak is above this value step is applied

- tuneStage:

    motor controlling the stage to adjust laser path

- stageStep:

    value of stage tuning step size

- loopPeriod:

    Time interval for feedback cycle

- doublecheckWaitTime:

    after peak is above max, this time is waiting to check itagain, before applying step

- calibStepSize:

    Size of calibration step

- calibStepNum:

    Number of calibration steps

- calibAverageNum:

    number of peak values to be averaged for each calibration step

- reverseDirection:

    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

- conversionFactor:

    micrometers to femtoseconds conversion factor

- adcValueTimeout:

    if ADC value is not updated within this time, device goesin error state

- amphosAmpli:

    Karabo ID of Amphos Laser Amplifier

- triggerDelayDevice:

    Karabo ID of pplDelayControl device, used to read Pockels cell status

- moveToPlus:

    Move to +x position

- moveToMinus:

    Move to -x position

- moveToZero:

    Move to 0 position

- pathToProgramFiles:

    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

- correctionFile:

    The correction (.ct5) file, including path.

- useExternalTrigger:

    Use external trigger (if true) or auto-run (if false).

- startFromMinusX:

    Set loop initial position to -X

- jumpSpeed:

    The up/down jump speed [bits/ms].

- jumpAmplitude:

    The up/down jump amplitude [bits].

- delayTimePlus:

    Delay time, after moving to position +x.

- delayTimeMinus:

    Delay time, after moving to position -x.

- onTargetTolerance:

    The tolerance [bits] when checking that Galvo is on target position.

- onTargetPlus:

    Galvo is currently at +x position _and_ not moving.

- onTargetMinus:

    Galvo is currently at -x position _and_ not moving.

- laserOn:

    The value of the LASERON signal.

- digitalOut1:

    The value of the DIGITAL OUT1 signal.

- stopEventCode:

    Stop event code.

- galvoTemperature:

    Galvanometer scanner temperature.

- servoTemperature:

    Servo board temperature.

- agcVoltage:

    AGC voltage (PD supply voltage).

- dspCoreVoltage:

    DSP core supply voltage (1.8 V).

- dspIoVoltage:

    DSP IO voltage (3.3 V).

- analogSectVoltage:

    Analog section voltage (9 V).

- adConverterVoltage:

    AD converter supply voltage (5 V).

- galvoHeatingOut:

    Relative heating output of the corresponding galvanometer scanner heater.

- beamline:

    Beamline where to operate

- timingDevice:

    Device ID of PPL Delay Control Device

- galvoDevice:

    id of Galvo Controller

- downstreamSpectr1Device:

    Spectrometer 1 (FXE/SCS)

- upstreamSpectr1Device:

    Spectrometer 1 (SPB/SQS)

- currentExperiment:

    Current MASTER experiment (UPSTREAM or DOWNSTREAM)

- currentVersion:

    Current version

- correctionFactorMaster:

    Correction Factor Master

- correctionFactorSlave:

    Correction Factor Slave

- switchProgress:

    Switching Progress

- switchExperiment:

    Procedure to automatically swap between FXE and SPB delay control and Galvo settings

- on:

    Instructs the device to switch on

- off:

    Instructs device to switch off

- lastError:

    Last error message received. Time is set by front-end firmware.

- scpiTimeout:

    The SCPI communication timeout.

- baseFreq:

    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

- frontendReset:

    send reset command

- s7ack:

    acknowledge to s7 command

- s8ack:

    acknowledge to s8 command

- s9ack:

    acknowledge to s9 command

- laserEmission:

    True when laser ON, false when OFF

- generalStatus:

    True = OK, False = not OK

- temperatureStatus:

    True = OK, False = not OK

- delayBoardStatus:

    True = OK, False = not OK

- inputPin0Status:

    True = OK, False = not OK

- inputPin4Status:

    True = OK, False = not OK

- pd1Voltage:

    Photodiode 1 (TAB 2) voltage

- pd1VoltageAverage:

    Averaged PD1 (TAB 2) voltage

- pd2Voltage:

    Photodiode 2 (TAB 5) voltage

- pd2VoltageAverage:

    Averaged PD2 (TAB 5) voltage

- pd3Voltage:

    PD3 (SPCO 1) voltage

- pd3VoltageAverage:

    Averaged PD3 (SPCO 1) voltage

- pd4Voltage:

    PD4 (TAB 7) voltage

- pd4VoltageAverage:

    Averaged PD4 (TAB 7) voltage

- pd5Voltage:

    PD5 (SPCO2) voltage

- pd5VoltageAverage:

    Averaged PD5 (SPCO2) voltage

- pd6Voltage:

    PD6 voltage

- pd6VoltageAverage:

    Averaged PD6 voltage

- pd7Voltage:

    PD7 voltage

- pd7VoltageAverage:

    Averaged PD7 voltage

- pd8Voltage:

    PD8 voltage

- pd8VoltageAverage:

    Averaged PD8 voltage

- seederOutPower:

    photodiode 1

- xf1OutPower:

    Photodiode 7

- xf2OutPower:

    Photodiode 8

- seederStatus:

    True = OK, False = not OK

- generalSeederStatus:

    True = OK, False = not OK

- hiltiErrorStatus:

    True = OK, False = not OK

- remoteControl:

    if it is false we cannot see it

- regOnOff0:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- regOnOff1:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- setpAX0:

    Variable SetpAx[0] define the setpoint of the servo loop.

- setpAY0:

    Variable SetpAy[0] define the setpoint of the servo loop.

- sumA0:

    Sum signal of angle detector ‘A’

- sumB0:

    Sum signal of position detector ‘B’

- aX0:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY0:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX0:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY0:

    Variable By represents the measured position deviation in y direction from zero position

- rAX0:

    Regulator Output Ax

- rAY0:

    Regulator Output Ay

- rBX0:

    Regulator Output Bx

- rBY0:

    Regulator Output By

- rAXM0:

    Regulator Output AxM

- rAYM0:

    Regulator Output AyM

- rBXM0:

    Regulator Output BxM

- rBYM0:

    Regulator Output ByM

- setpAX1:

    Variable SetpAx[1] define the setpoint of the servo loop.

- setpAY1:

    Variable SetpAy[1] define the setpoint of the servo loop.

- sumA1:

    Sum signal of angle detector ‘A’

- sumB1:

    Sum signal of position detector ‘B’

- aX1:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY1:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX1:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY1:

    Variable By represents the measured position deviation in y direction from zero position

- rAX1:

    Regulator Output Ax

- rAY1:

    Regulator Output Ay

- rBX1:

    Regulator Output Bx

- rBY1:

    Regulator Output By

- rAXM1:

    Regulator Output AxM

- rAYM1:

    Regulator Output AyM

- rBXM1:

    Regulator Output BxM

- rBYM1:

    Regulator Output ByM

- stage1Id:

    Karabo device ID of first grating motor

- stage2Id:

    Karabo device ID of first grating motor

- tunnel:

    Location where doocs_device is deployed (e.g. ‘SASE1’)

- labx2MName:

    DOOCS name of X2 Master doocs_device

- labx2SName:

    DOOCS name of X2 Slave doocs_device

- timingShifterName:

    DOOCS name of Phase Shifter doocs_device

- manualTuning:

    Manual Tuning Enable

- useShifter:

    Set to True if optical synchronization is available

- midTsValue:

    Mid Value of Phase Shifter

- maxTsDelay:

    Maximum delay to add/subtract to phase shifter position

- maxTsJitter:

    Maximum allowed jitter

- laserOpModeList:

    Select Laser Op Mode

- activeLaserOpMode:

    Active Op laser Mode

- laserOpModeListApply:

    Apply Laser Operation Mode

- dmBCCAuto:

    Automatic loop on/off

- pCellState:

    Status of Pockels Cell, True = On

- pCellOn:

    Set Pockels cell on

- pCellOff:

    Set Pockels cell off

- AOMState:

    Status of AOM, True = On

- AOMOn:

    Set AOM on

- AOMOff:

    Set AOM off

- maxAllowedPcPhase:

    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

- mPCCLKPhase:

    Master PC Phase

- mSWPCCLKPhase:

    Master SW PC Phase

- mBurstWidth:

    Master burst width [us]

- mBurstWidthApply:

    Apply m Burst Width

- mBurstStart:

    Begining of the bursts the slave burst is +50ms)

- mBurstStartsms:

    Master burst starts pos. [us]

- sBurstStartsms:

    Sleve burst starts pos. [us]

- smBurstDiff:

    Different between muster and slave burst positione

- sPCCLKPhase:

    Master PC Phase

- sSWPCCLKPhase:

    Slave software PC PHase

- sBurstWidth:

    Slave burst width [us]

- sBurstWidthApply:

    Apply S Burst width

- delayBPMaster:

    Current delay of the master bunch pattern in clock unit (machine)

- delayBPMasterP:

    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterM:

    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterP24:

    Increment Master Bunch Pattern delay by 24 clock unit

- delayBPMasterM24:

    Decrement Master Bunch Pattern delay by 24 clock unit

- delayBPSlave:

    Current delay of the slave bunch pattern in clock unit (machine)

- delayBPSlaveP:

    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveM:

    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveP24:

    Increment Slave Bunch Pattern delay by 24 clock unit

- delayBPSlaveM24:

    Decrement Slave Bunch Pattern delay by 24 clock unit

- masterExpPattern:

    Select pattern for master experiment

- slaveExpPattern:

    Select pattern for slave experiment

- currentLaserPatterns:

    Current Laser Patterns

- currentMasterLaserPattern:

    Current Master Laser Patterns

- currentSlaveLaserPattern:

    Current Slave Laser Patterns

- currentSlaveLaserPatternN:

    Current Slave Laser Pattern

- fineDelayMaxCounts:

    Fine delay - maximum count number

- fineDelayValue:

    fine delay count value

- fineDelayValueT:

    fine delay time value

- fineDelayP:

    Increment fine delay

- fineDelayM:

    Decrement fine delay

- fineDelay9nsChange:

    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

- fineDelay9ns:

    Change Fine Delay by 9 ns

- minTsPosition:

    Minimum Timing Shifter Delay

- maxTsPosition:

    Maximum Timing Shifter Delay

- currentTsPosition:

    current value of time shifter position

- requestedTsDelay:

    Delay to apply to the phase shifter

- DelayTsChange:

    Change phase shifter by requested value

- relAbsolutTsPos:

    True for relative, False for absolute

- stopPsChange:

    Abort phase shift change

- opticalSynch:

    Display status of optical synchronization

- opticalSynchLock:

    Display lock status of optical synchronization

- opticalSynchJitter:

    Display status of optical synchronization jitter

- opticalSynchMode:

    Optical synch. mode (RF / Optical)

- setOpticalDelay:

    Delay to apply to optical delay line

- applyOpticalDelay:

    change the optical delay by requeste value

- currentOpticalDelay:

    Current position of optical delay

- relAbsolutDelayLine:

    True for relative, False for absolute

- TsJitter:

    Optical Synchronization Jitter

- triggerFE_DOWNSTREAM:

    Current trigger delay FE DOWNSTREAM

- triggerFE_UPSTREAM:

    Current trigger delay FE UPSTREAM

- getCurrentHardwareStatus:

    Read configuration from hardware

- lastShiftDelay:

    FE delay value from the prevoius shift

- setLastShiftDelay:

    Bring the delay to position from the previus shift

- clearLock:

    In case of STATE == changing bring the state to Normal

- mPCCLKPhaseSetValue:

    Master PC CLK Phase Value

- sPCCLKPhaseSetValue:

    Slave PC CLK Phase Value

- delayBPMasterSetValue:

    Master BP delay Value

- delayBPSlaveSetValue:

    Slave BP delay Value

- resetError:

    Reset error state

- upstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for upstream instrument

- downstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for downstream instrument

- shiftChange:

    Swaps MASTER and SLAVE properties between upstream and downstream instrument

- isOxcActive:

    Status of optical lock (True: OPTICAL mode, False: RF mode)

- requestedDelay:

    Relative delay to be applied by delay change (Trigger Position)

- delayChange:

    Change delay value by applying (relative) offset

- mPCCLKPhaseP:

    Increment PC master Phase

- mPCCLKPhaseM:

    Decrement PC master Phase

- sPCCLKPhaseP:

    Increment slave PC Phase

- sPCCLKPhaseM:

    Decrement slave PC phase

- savemSWPCCLKPhase:

    Save new software phase value for PCm

- savesSWPCCLKPhase:

    Save new software phase value for PCs

- mBurstStartApply:

    Apply Burst Start Pos

- takemidTsValue:

    Take mid value of phase shifter

- logBoardsStatus:

    JSON string describing master and slave board settings.Usually updated when user actions are taken

- logFineDelay:

    JSON string describing fine delay settings.Usually updated when user actions are taken

- imgprocDevice:

    Device ID of image processor used for feedback

- temDevice:

    id of tem device

- temChannel:

    TEM channel to be controlled

- xCoefWeight:

    weight of X coefficient

- yCoefWeight:

    weight of Y coefficient

- axCoefOld:

    Value of Ax Coefficient saved prior to calibration

- ayCoefOld:

    Value of Ay Coefficient saved prior to calibration

- xBeamCenterTarget:

    desired value for Beam Center X coordinate

- yBeamCenterTarget:

    desired value for Beam Center Y coordinate

- beamCenterMaxDisplacement:

    maximum allowed displacement for Center of Mass from target position

- maxTemDrift:

    Maximum value allowed for TEM drift

- averageNumber:

    number of values of beam center coordinates to average

- timeoutImageProcessorValues:

    Time to wait before going in error when values from image processor are not updating

- imageSettlementTime:

    Time to wait before reading beam center coordinates aftermoving TEM setpoint

- calibrationStep:

    TEM setpoint step size for calibration

- calibrationStepsNumber:

    Number of TEM calibration steps

- maxTimeNotRegulating:

    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

- setCurrentPosAsTarget:

    Set current beam position as target

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

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

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

###### TRACEYCOMP_SPB_2

Instance id: | LA1_LAS_PPL/DCTRL/TRACEYCOMP_SPB_2
Host: | exflcon14n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

Device Schema Description

- _serverId_:

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

- _deviceId_:

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

- _connection_:

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

- visibility:

    Configures who is allowed to see this device at all

- deviceId:

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

- classId:

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

- classVersion:

    The version of the class of this device defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- alarmCondition:

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

- lastCommand:

    The last slot called.

- archive:

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

- useTimeserver:

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

- progress:

    The progress of the current action

- heartbeatInterval:

    The heartbeat interval

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

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

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

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

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

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

- epsilon:

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

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

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

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

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

- maxStateUpdateRate:

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

- noisyStateUpdateRateValue:

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

- isStateUpdateNoisy:

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

- reset:

    Resets the PLC hardware

- enableInterlockedSlots:

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

- disableInterlockedSlots:

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

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

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

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

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

- readHardware:

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

- force:

    ???

- trigger:

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

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- value:

    Analog input of ADC.

- scale:

    Scaling factor for analog value.

- offset:

    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!

- start:

    Instructs device to go to started state

- stop:

    Instructs device to go to stopped state

- resetADC:

    Reset ADC’s of FPGA in case of constant line, No signal

- resetDDR2:

    Resets DDR2 in case of constant line, No signal

- deviceFile:

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

- mapDirectory:

    Folder where all xml mapping files are located.

- numberRawSamples:

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

- delay:

    Delay between calibration images.

- skipSamples:

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

- triggerTime:

    Time between Triggers

- triggerTimeStat:

    Histogram of time between Triggers

- trainId:

    Current train ID as read from the FPGA

- config:

    Board related configuration parameters.

- dacNode:

    Set up DAC parameters

- channel_0:

    This is a channel of bunch of other parameters

- channel_1:

    This is a channel of bunch of other parameters

- channel_2:

    This is a channel of bunch of other parameters

- channel_3:

    This is a channel of bunch of other parameters

- channel_4:

    This is a channel of bunch of other parameters

- channel_5:

    This is a channel of bunch of other parameters

- channel_6:

    This is a channel of bunch of other parameters

- channel_7:

    This is a channel of bunch of other parameters

- channel_8:

    This is a channel of bunch of other parameters

- channel_9:

    This is a channel of bunch of other parameters

- semiRawValue:

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

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- timeServerId:

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

- Logger:

    Logging settings

- sendCommand:

    Send command to the instrument.

- replyToCommand:

    Reply to the command send to the instrument.

- gotoErrorOnPollFailure:

    Instrument will go to error if poll fails for all properties.

- autoConnect:

    Set True to automatically connect to device.

- pollingInterval:

    The interval for polling the instrument.

- enableHeartbeat:

    Enable Heartbeat

- heartbeatCommand:

    Text to send as heartbeat

- heartbeatReply:

    Heartbeat reply text

- heartbeatPeriod:

    Heartbeat period

- heartbeatTime:

    Last heartbeat time

- pollingTimeTaken:

    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

- pollNow:

    Poll instrument now!

- _connect_:

    Connects to the device

- disconnect:

    Disconnects from the device

- handshake:

    Set the state of the message roundtrip handshaking.

- baudRate:

    Set the transmit and receive baud rates on the RS-232 port.

- errorCount:

    The number of error records in the queue.

- measureType:

    Set the meter measurement mode (energy or power).

- statisticsMode:

    Set the statistics processing mode (on or off).

- variableDecimation:

    Set the pulse decimation rate (1-99999).

- apertureDiameter:

    Set the aperture diameter.

- wavelength:

    Set the current wavelength.

- gainCompensation:

    Enables or disables the gain compensation.

- gainFactor:

    Set the gain compensation factor.

- range:

    Set the measurement range (maximum expected measurement).

- batchSize:

    Set the statistics batch size.

- restartMode:

    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

- statStart:

    Terminates the current statistical batch and start a new one.

- statStop:

    Terminates the current statistical batch.

- triggerSource:

    Selects the trigger source (INTernal / EXTernal).

- triggerLevel:

    Set the trigger level (no effect when external trigger is selected).

- triggerSlope:

    Selects the external trigger edge (POSitive / NEGative).

- sequenceId:

    Set the sequence ID.

- triggerBus:

    Selects the trigger bus participation mode.

- itemSelect:

    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

- statItemSelect:

    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

- serialNumber:

    The serial number string.

- partNumber:

    The part number.

- modelName:

    The Model Name.

- calibrationDate:

    The calibration date.

- manifacturingDate:

    The manifacturing date.

- defaultWavelength:

    The default wavelength.

- measurementRefreshRate:

    The refresh rate of measurements.

- measurement:

    Last measurement.

- idType:

    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

- cameraId:

    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

- packetDelay:

    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

- autoPacketSize:

    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

- packetSize:

    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

- exposureTime:

    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

- triggerMode:

    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

- triggerActivation:

    This enumeration sets the signal transition needed to activate the selected trigger.

- autoGain:

    Configures automatic gain feature.

- gain:

    Sets the gain of the ADC converter.

- acquisitionMode:

    This property sets the image acquisition mode.

- frameCount:

    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

- xPeak1:

    x-position of peak in first calibration image.

- xFWHM1:

    x-FWHM in first calibration image.

- xPeak2:

    x-position of peak in second calibration image.

- xFWHM2:

    x-FWHM in second calibration image.

- delayUnit:

    Unit of the delay between calibration images.

- useAsCalibrationImage1:

    Use the current image as 1st calibration image.

- useAsCalibrationImage2:

    Use the current image as 2nd calibration image.

- calibrate:

  > perform calibrationStepsNumber steps of calibrationStep size starting and ending in symmetrical places relatively to initial position, both along X and Y, while measuring center of beam position.

  > Use these measurements to calculate axCoef and ayCoef.

  > Assumptions that are made: sin(x) ~= x x(y) axis of TEM parallel to x (y) axis of camera

- calibrationFactor:

    The calibration constant.

- beamShape:

    Time shape of the beam.

- xMinFit:

    Lower limit for the fit.

- xMaxFit:

    Upper limit for the fit.

- fitStatus:

    Error of fit procedure: 1-3 means good fit. See device documentation for further details.

- subtractPedestal:

    Subtract the pedestal, calculated from linear interpolation between first and last point.

- xPeak3:

    x-position of peak in the input image.

- xFWHM3:

    x-FWHM in the input image.

- pulseWidth:

    Duration of the pulse.

- ePulseWidth:

    Uncertainty of the pulse duration arising from fit procedure.

- switchToReady:

    Instructs the amplifier to go to ready state.

- switchOn:

    Instructs the amplifier to go to on state.

- switchOff:

    Instructs the amplifier to go to off state.

- closeShutter2:

    Instructs the amplifier to close Shutter 2.

- openShutter2:

    Instructs the amplifier to open Shutter 2.

- amphosIp:

    The IP address of the Amphos Control.

- amphosPort:

    The port of the Amphos Control.

- stateChanging:

    Laser is currently changing state.

- targetPower:

    Target laser power.

- chillerTemperature:

    Measured temperature of chiller.

- chillerFlow:

    Measured flow of chiller [l/min].

- chillerValvePosition:

    Measured valve position.

- shutter2IsOpen:

    Shutter2 State: False=closed True=open

- lambdaIsBusy:

    Lambda plate is moving.

- laserCurrent:

    Measured current of Amphos400.

- laserTemperature:

    Measured temperature of Amphos400.

- laserHumidity:

    Measured humidity of Amphos400.

- xfelCurrentCW1:

    Measured current of XFEL booster 1 (CW1).

- xfelCurrentCW2:

    Measured current of XFEL booster 1 (CW2).

- xfelCurrentQCW1:

    Measured current of XFEL booster 1 (QCW1).

- xfelCurrentQCW2:

    Measured current of XFEL booster 1 (QCW2).

- xfelCurrentQCW3:

    Measured current of XFEL booster 1 (QCW3).

- xfelCurrentQCW4:

    Measured current of XFEL booster 1 (QCW3).

- xfelTemperature:

    Measured temperature of XFEL booster 1.

- xfelHumidity:

    Measured humidity of XFEL booster 1.

- globalAlarmCondition:

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

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- log:

    Logging settings

- adc:

    fast ADC input device

- selectedAdcChannel:

    fast ADC channel in use for the loop

- maxPeakValue:

    Max absolute value for ADC peak. When peak is above this value step is applied

- tuneStage:

    motor controlling the stage to adjust laser path

- stageStep:

    value of stage tuning step size

- loopPeriod:

    Time interval for feedback cycle

- doublecheckWaitTime:

    after peak is above max, this time is waiting to check itagain, before applying step

- calibStepSize:

    Size of calibration step

- calibStepNum:

    Number of calibration steps

- calibAverageNum:

    number of peak values to be averaged for each calibration step

- reverseDirection:

    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

- conversionFactor:

    micrometers to femtoseconds conversion factor

- adcValueTimeout:

    if ADC value is not updated within this time, device goesin error state

- amphosAmpli:

    Karabo ID of Amphos Laser Amplifier

- triggerDelayDevice:

    Karabo ID of pplDelayControl device, used to read Pockels cell status

- moveToPlus:

    Move to +x position

- moveToMinus:

    Move to -x position

- moveToZero:

    Move to 0 position

- pathToProgramFiles:

    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

- correctionFile:

    The correction (.ct5) file, including path.

- useExternalTrigger:

    Use external trigger (if true) or auto-run (if false).

- startFromMinusX:

    Set loop initial position to -X

- jumpSpeed:

    The up/down jump speed [bits/ms].

- jumpAmplitude:

    The up/down jump amplitude [bits].

- delayTimePlus:

    Delay time, after moving to position +x.

- delayTimeMinus:

    Delay time, after moving to position -x.

- onTargetTolerance:

    The tolerance [bits] when checking that Galvo is on target position.

- onTargetPlus:

    Galvo is currently at +x position _and_ not moving.

- onTargetMinus:

    Galvo is currently at -x position _and_ not moving.

- laserOn:

    The value of the LASERON signal.

- digitalOut1:

    The value of the DIGITAL OUT1 signal.

- stopEventCode:

    Stop event code.

- galvoTemperature:

    Galvanometer scanner temperature.

- servoTemperature:

    Servo board temperature.

- agcVoltage:

    AGC voltage (PD supply voltage).

- dspCoreVoltage:

    DSP core supply voltage (1.8 V).

- dspIoVoltage:

    DSP IO voltage (3.3 V).

- analogSectVoltage:

    Analog section voltage (9 V).

- adConverterVoltage:

    AD converter supply voltage (5 V).

- galvoHeatingOut:

    Relative heating output of the corresponding galvanometer scanner heater.

- beamline:

    Beamline where to operate

- timingDevice:

    Device ID of PPL Delay Control Device

- galvoDevice:

    id of Galvo Controller

- downstreamSpectr1Device:

    Spectrometer 1 (FXE/SCS)

- upstreamSpectr1Device:

    Spectrometer 1 (SPB/SQS)

- currentExperiment:

    Current MASTER experiment (UPSTREAM or DOWNSTREAM)

- currentVersion:

    Current version

- correctionFactorMaster:

    Correction Factor Master

- correctionFactorSlave:

    Correction Factor Slave

- switchProgress:

    Switching Progress

- switchExperiment:

    Procedure to automatically swap between FXE and SPB delay control and Galvo settings

- on:

    Instructs the device to switch on

- off:

    Instructs device to switch off

- lastError:

    Last error message received. Time is set by front-end firmware.

- scpiTimeout:

    The SCPI communication timeout.

- baseFreq:

    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

- frontendReset:

    send reset command

- s7ack:

    acknowledge to s7 command

- s8ack:

    acknowledge to s8 command

- s9ack:

    acknowledge to s9 command

- laserEmission:

    True when laser ON, false when OFF

- generalStatus:

    True = OK, False = not OK

- temperatureStatus:

    True = OK, False = not OK

- delayBoardStatus:

    True = OK, False = not OK

- inputPin0Status:

    True = OK, False = not OK

- inputPin4Status:

    True = OK, False = not OK

- pd1Voltage:

    Photodiode 1 (TAB 2) voltage

- pd1VoltageAverage:

    Averaged PD1 (TAB 2) voltage

- pd2Voltage:

    Photodiode 2 (TAB 5) voltage

- pd2VoltageAverage:

    Averaged PD2 (TAB 5) voltage

- pd3Voltage:

    PD3 (SPCO 1) voltage

- pd3VoltageAverage:

    Averaged PD3 (SPCO 1) voltage

- pd4Voltage:

    PD4 (TAB 7) voltage

- pd4VoltageAverage:

    Averaged PD4 (TAB 7) voltage

- pd5Voltage:

    PD5 (SPCO2) voltage

- pd5VoltageAverage:

    Averaged PD5 (SPCO2) voltage

- pd6Voltage:

    PD6 voltage

- pd6VoltageAverage:

    Averaged PD6 voltage

- pd7Voltage:

    PD7 voltage

- pd7VoltageAverage:

    Averaged PD7 voltage

- pd8Voltage:

    PD8 voltage

- pd8VoltageAverage:

    Averaged PD8 voltage

- seederOutPower:

    photodiode 1

- xf1OutPower:

    Photodiode 7

- xf2OutPower:

    Photodiode 8

- seederStatus:

    True = OK, False = not OK

- generalSeederStatus:

    True = OK, False = not OK

- hiltiErrorStatus:

    True = OK, False = not OK

- remoteControl:

    if it is false we cannot see it

- regOnOff0:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- regOnOff1:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- setpAX0:

    Variable SetpAx[0] define the setpoint of the servo loop.

- setpAY0:

    Variable SetpAy[0] define the setpoint of the servo loop.

- sumA0:

    Sum signal of angle detector ‘A’

- sumB0:

    Sum signal of position detector ‘B’

- aX0:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY0:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX0:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY0:

    Variable By represents the measured position deviation in y direction from zero position

- rAX0:

    Regulator Output Ax

- rAY0:

    Regulator Output Ay

- rBX0:

    Regulator Output Bx

- rBY0:

    Regulator Output By

- rAXM0:

    Regulator Output AxM

- rAYM0:

    Regulator Output AyM

- rBXM0:

    Regulator Output BxM

- rBYM0:

    Regulator Output ByM

- setpAX1:

    Variable SetpAx[1] define the setpoint of the servo loop.

- setpAY1:

    Variable SetpAy[1] define the setpoint of the servo loop.

- sumA1:

    Sum signal of angle detector ‘A’

- sumB1:

    Sum signal of position detector ‘B’

- aX1:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY1:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX1:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY1:

    Variable By represents the measured position deviation in y direction from zero position

- rAX1:

    Regulator Output Ax

- rAY1:

    Regulator Output Ay

- rBX1:

    Regulator Output Bx

- rBY1:

    Regulator Output By

- rAXM1:

    Regulator Output AxM

- rAYM1:

    Regulator Output AyM

- rBXM1:

    Regulator Output BxM

- rBYM1:

    Regulator Output ByM

- stage1Id:

    Karabo device ID of first grating motor

- stage2Id:

    Karabo device ID of first grating motor

- tunnel:

    Location where doocs_device is deployed (e.g. ‘SASE1’)

- labx2MName:

    DOOCS name of X2 Master doocs_device

- labx2SName:

    DOOCS name of X2 Slave doocs_device

- timingShifterName:

    DOOCS name of Phase Shifter doocs_device

- manualTuning:

    Manual Tuning Enable

- useShifter:

    Set to True if optical synchronization is available

- midTsValue:

    Mid Value of Phase Shifter

- maxTsDelay:

    Maximum delay to add/subtract to phase shifter position

- maxTsJitter:

    Maximum allowed jitter

- laserOpModeList:

    Select Laser Op Mode

- activeLaserOpMode:

    Active Op laser Mode

- laserOpModeListApply:

    Apply Laser Operation Mode

- dmBCCAuto:

    Automatic loop on/off

- pCellState:

    Status of Pockels Cell, True = On

- pCellOn:

    Set Pockels cell on

- pCellOff:

    Set Pockels cell off

- AOMState:

    Status of AOM, True = On

- AOMOn:

    Set AOM on

- AOMOff:

    Set AOM off

- maxAllowedPcPhase:

    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

- mPCCLKPhase:

    Master PC Phase

- mSWPCCLKPhase:

    Master SW PC Phase

- mBurstWidth:

    Master burst width [us]

- mBurstWidthApply:

    Apply m Burst Width

- mBurstStart:

    Begining of the bursts the slave burst is +50ms)

- mBurstStartsms:

    Master burst starts pos. [us]

- sBurstStartsms:

    Sleve burst starts pos. [us]

- smBurstDiff:

    Different between muster and slave burst positione

- sPCCLKPhase:

    Master PC Phase

- sSWPCCLKPhase:

    Slave software PC PHase

- sBurstWidth:

    Slave burst width [us]

- sBurstWidthApply:

    Apply S Burst width

- delayBPMaster:

    Current delay of the master bunch pattern in clock unit (machine)

- delayBPMasterP:

    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterM:

    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterP24:

    Increment Master Bunch Pattern delay by 24 clock unit

- delayBPMasterM24:

    Decrement Master Bunch Pattern delay by 24 clock unit

- delayBPSlave:

    Current delay of the slave bunch pattern in clock unit (machine)

- delayBPSlaveP:

    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveM:

    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveP24:

    Increment Slave Bunch Pattern delay by 24 clock unit

- delayBPSlaveM24:

    Decrement Slave Bunch Pattern delay by 24 clock unit

- masterExpPattern:

    Select pattern for master experiment

- slaveExpPattern:

    Select pattern for slave experiment

- currentLaserPatterns:

    Current Laser Patterns

- currentMasterLaserPattern:

    Current Master Laser Patterns

- currentSlaveLaserPattern:

    Current Slave Laser Patterns

- currentSlaveLaserPatternN:

    Current Slave Laser Pattern

- fineDelayMaxCounts:

    Fine delay - maximum count number

- fineDelayValue:

    fine delay count value

- fineDelayValueT:

    fine delay time value

- fineDelayP:

    Increment fine delay

- fineDelayM:

    Decrement fine delay

- fineDelay9nsChange:

    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

- fineDelay9ns:

    Change Fine Delay by 9 ns

- minTsPosition:

    Minimum Timing Shifter Delay

- maxTsPosition:

    Maximum Timing Shifter Delay

- currentTsPosition:

    current value of time shifter position

- requestedTsDelay:

    Delay to apply to the phase shifter

- DelayTsChange:

    Change phase shifter by requested value

- relAbsolutTsPos:

    True for relative, False for absolute

- stopPsChange:

    Abort phase shift change

- opticalSynch:

    Display status of optical synchronization

- opticalSynchLock:

    Display lock status of optical synchronization

- opticalSynchJitter:

    Display status of optical synchronization jitter

- opticalSynchMode:

    Optical synch. mode (RF / Optical)

- setOpticalDelay:

    Delay to apply to optical delay line

- applyOpticalDelay:

    change the optical delay by requeste value

- currentOpticalDelay:

    Current position of optical delay

- relAbsolutDelayLine:

    True for relative, False for absolute

- TsJitter:

    Optical Synchronization Jitter

- triggerFE_DOWNSTREAM:

    Current trigger delay FE DOWNSTREAM

- triggerFE_UPSTREAM:

    Current trigger delay FE UPSTREAM

- getCurrentHardwareStatus:

    Read configuration from hardware

- lastShiftDelay:

    FE delay value from the prevoius shift

- setLastShiftDelay:

    Bring the delay to position from the previus shift

- clearLock:

    In case of STATE == changing bring the state to Normal

- mPCCLKPhaseSetValue:

    Master PC CLK Phase Value

- sPCCLKPhaseSetValue:

    Slave PC CLK Phase Value

- delayBPMasterSetValue:

    Master BP delay Value

- delayBPSlaveSetValue:

    Slave BP delay Value

- resetError:

    Reset error state

- upstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for upstream instrument

- downstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for downstream instrument

- shiftChange:

    Swaps MASTER and SLAVE properties between upstream and downstream instrument

- isOxcActive:

    Status of optical lock (True: OPTICAL mode, False: RF mode)

- requestedDelay:

    Relative delay to be applied by delay change (Trigger Position)

- delayChange:

    Change delay value by applying (relative) offset

- mPCCLKPhaseP:

    Increment PC master Phase

- mPCCLKPhaseM:

    Decrement PC master Phase

- sPCCLKPhaseP:

    Increment slave PC Phase

- sPCCLKPhaseM:

    Decrement slave PC phase

- savemSWPCCLKPhase:

    Save new software phase value for PCm

- savesSWPCCLKPhase:

    Save new software phase value for PCs

- mBurstStartApply:

    Apply Burst Start Pos

- takemidTsValue:

    Take mid value of phase shifter

- logBoardsStatus:

    JSON string describing master and slave board settings.Usually updated when user actions are taken

- logFineDelay:

    JSON string describing fine delay settings.Usually updated when user actions are taken

- imgprocDevice:

    Device ID of image processor used for feedback

- temDevice:

    id of tem device

- temChannel:

    TEM channel to be controlled

- xCoefWeight:

    weight of X coefficient

- yCoefWeight:

    weight of Y coefficient

- axCoefOld:

    Value of Ax Coefficient saved prior to calibration

- ayCoefOld:

    Value of Ay Coefficient saved prior to calibration

- xBeamCenterTarget:

    desired value for Beam Center X coordinate

- yBeamCenterTarget:

    desired value for Beam Center Y coordinate

- beamCenterMaxDisplacement:

    maximum allowed displacement for Center of Mass from target position

- maxTemDrift:

    Maximum value allowed for TEM drift

- averageNumber:

    number of values of beam center coordinates to average

- timeoutImageProcessorValues:

    Time to wait before going in error when values from image processor are not updating

- imageSettlementTime:

    Time to wait before reading beam center coordinates aftermoving TEM setpoint

- calibrationStep:

    TEM setpoint step size for calibration

- calibrationStepsNumber:

    Number of TEM calibration steps

- maxTimeNotRegulating:

    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

- setCurrentPosAsTarget:

    Set current beam position as target

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

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

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

##### ENC

[add component documentation]

###### CMCOMPSTAGE

Instance id: | LA1_LAS_PPL/ENC/CMCOMPSTAGE
Host: | exflcon14n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

Device Schema Description

- _serverId_:

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

- _deviceId_:

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

- _connection_:

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

- visibility:

    Configures who is allowed to see this device at all

- deviceId:

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

- classId:

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

- classVersion:

    The version of the class of this device defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- alarmCondition:

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

- lastCommand:

    The last slot called.

- archive:

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

- useTimeserver:

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

- progress:

    The progress of the current action

- heartbeatInterval:

    The heartbeat interval

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

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

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

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

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

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

- epsilon:

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

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

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

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

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

- maxStateUpdateRate:

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

- noisyStateUpdateRateValue:

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

- isStateUpdateNoisy:

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

- reset:

    Resets the PLC hardware

- enableInterlockedSlots:

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

- disableInterlockedSlots:

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

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

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

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

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

- readHardware:

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

- force:

    ???

- trigger:

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

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- value:

    Encoder read value

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

- start:

    Instructs device to go to started state

- stop:

    Instructs device to go to stopped state

- resetADC:

    Reset ADC’s of FPGA in case of constant line, No signal

- resetDDR2:

    Resets DDR2 in case of constant line, No signal

- deviceFile:

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

- mapDirectory:

    Folder where all xml mapping files are located.

- numberRawSamples:

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

- delay:

    Delay between calibration images.

- skipSamples:

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

- triggerTime:

    Time between Triggers

- triggerTimeStat:

    Histogram of time between Triggers

- trainId:

    Current train ID as read from the FPGA

- config:

    Board related configuration parameters.

- dacNode:

    Set up DAC parameters

- channel_0:

    This is a channel of bunch of other parameters

- channel_1:

    This is a channel of bunch of other parameters

- channel_2:

    This is a channel of bunch of other parameters

- channel_3:

    This is a channel of bunch of other parameters

- channel_4:

    This is a channel of bunch of other parameters

- channel_5:

    This is a channel of bunch of other parameters

- channel_6:

    This is a channel of bunch of other parameters

- channel_7:

    This is a channel of bunch of other parameters

- channel_8:

    This is a channel of bunch of other parameters

- channel_9:

    This is a channel of bunch of other parameters

- semiRawValue:

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

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- timeServerId:

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

- Logger:

    Logging settings

- sendCommand:

    Send command to the instrument.

- replyToCommand:

    Reply to the command send to the instrument.

- gotoErrorOnPollFailure:

    Instrument will go to error if poll fails for all properties.

- autoConnect:

    Set True to automatically connect to device.

- pollingInterval:

    The interval for polling the instrument.

- enableHeartbeat:

    Enable Heartbeat

- heartbeatCommand:

    Text to send as heartbeat

- heartbeatReply:

    Heartbeat reply text

- heartbeatPeriod:

    Heartbeat period

- heartbeatTime:

    Last heartbeat time

- pollingTimeTaken:

    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

- pollNow:

    Poll instrument now!

- _connect_:

    Connects to the device

- disconnect:

    Disconnects from the device

- handshake:

    Set the state of the message roundtrip handshaking.

- baudRate:

    Set the transmit and receive baud rates on the RS-232 port.

- errorCount:

    The number of error records in the queue.

- measureType:

    Set the meter measurement mode (energy or power).

- statisticsMode:

    Set the statistics processing mode (on or off).

- variableDecimation:

    Set the pulse decimation rate (1-99999).

- apertureDiameter:

    Set the aperture diameter.

- wavelength:

    Set the current wavelength.

- gainCompensation:

    Enables or disables the gain compensation.

- gainFactor:

    Set the gain compensation factor.

- range:

    Set the measurement range (maximum expected measurement).

- batchSize:

    Set the statistics batch size.

- restartMode:

    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

- statStart:

    Terminates the current statistical batch and start a new one.

- statStop:

    Terminates the current statistical batch.

- triggerSource:

    Selects the trigger source (INTernal / EXTernal).

- triggerLevel:

    Set the trigger level (no effect when external trigger is selected).

- triggerSlope:

    Selects the external trigger edge (POSitive / NEGative).

- sequenceId:

    Set the sequence ID.

- triggerBus:

    Selects the trigger bus participation mode.

- itemSelect:

    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

- statItemSelect:

    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

- serialNumber:

    The serial number string.

- partNumber:

    The part number.

- modelName:

    The Model Name.

- calibrationDate:

    The calibration date.

- manifacturingDate:

    The manifacturing date.

- defaultWavelength:

    The default wavelength.

- measurementRefreshRate:

    The refresh rate of measurements.

- measurement:

    Last measurement.

- idType:

    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

- cameraId:

    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

- packetDelay:

    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

- autoPacketSize:

    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

- packetSize:

    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

- exposureTime:

    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

- triggerMode:

    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

- triggerActivation:

    This enumeration sets the signal transition needed to activate the selected trigger.

- autoGain:

    Configures automatic gain feature.

- gain:

    Sets the gain of the ADC converter.

- acquisitionMode:

    This property sets the image acquisition mode.

- frameCount:

    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

- xPeak1:

    x-position of peak in first calibration image.

- xFWHM1:

    x-FWHM in first calibration image.

- xPeak2:

    x-position of peak in second calibration image.

- xFWHM2:

    x-FWHM in second calibration image.

- delayUnit:

    Unit of the delay between calibration images.

- useAsCalibrationImage1:

    Use the current image as 1st calibration image.

- useAsCalibrationImage2:

    Use the current image as 2nd calibration image.

- calibrate:

  > perform calibrationStepsNumber steps of calibrationStep size starting and ending in symmetrical places relatively to initial position, both along X and Y, while measuring center of beam position.

  > Use these measurements to calculate axCoef and ayCoef.

  > Assumptions that are made: sin(x) ~= x x(y) axis of TEM parallel to x (y) axis of camera

- calibrationFactor:

    The calibration constant.

- beamShape:

    Time shape of the beam.

- xMinFit:

    Lower limit for the fit.

- xMaxFit:

    Upper limit for the fit.

- fitStatus:

    Error of fit procedure: 1-3 means good fit. See device documentation for further details.

- subtractPedestal:

    Subtract the pedestal, calculated from linear interpolation between first and last point.

- xPeak3:

    x-position of peak in the input image.

- xFWHM3:

    x-FWHM in the input image.

- pulseWidth:

    Duration of the pulse.

- ePulseWidth:

    Uncertainty of the pulse duration arising from fit procedure.

- switchToReady:

    Instructs the amplifier to go to ready state.

- switchOn:

    Instructs the amplifier to go to on state.

- switchOff:

    Instructs the amplifier to go to off state.

- closeShutter2:

    Instructs the amplifier to close Shutter 2.

- openShutter2:

    Instructs the amplifier to open Shutter 2.

- amphosIp:

    The IP address of the Amphos Control.

- amphosPort:

    The port of the Amphos Control.

- stateChanging:

    Laser is currently changing state.

- targetPower:

    Target laser power.

- chillerTemperature:

    Measured temperature of chiller.

- chillerFlow:

    Measured flow of chiller [l/min].

- chillerValvePosition:

    Measured valve position.

- shutter2IsOpen:

    Shutter2 State: False=closed True=open

- lambdaIsBusy:

    Lambda plate is moving.

- laserCurrent:

    Measured current of Amphos400.

- laserTemperature:

    Measured temperature of Amphos400.

- laserHumidity:

    Measured humidity of Amphos400.

- xfelCurrentCW1:

    Measured current of XFEL booster 1 (CW1).

- xfelCurrentCW2:

    Measured current of XFEL booster 1 (CW2).

- xfelCurrentQCW1:

    Measured current of XFEL booster 1 (QCW1).

- xfelCurrentQCW2:

    Measured current of XFEL booster 1 (QCW2).

- xfelCurrentQCW3:

    Measured current of XFEL booster 1 (QCW3).

- xfelCurrentQCW4:

    Measured current of XFEL booster 1 (QCW3).

- xfelTemperature:

    Measured temperature of XFEL booster 1.

- xfelHumidity:

    Measured humidity of XFEL booster 1.

- globalAlarmCondition:

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

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- log:

    Logging settings

- adc:

    fast ADC input device

- selectedAdcChannel:

    fast ADC channel in use for the loop

- maxPeakValue:

    Max absolute value for ADC peak. When peak is above this value step is applied

- tuneStage:

    motor controlling the stage to adjust laser path

- stageStep:

    value of stage tuning step size

- loopPeriod:

    Time interval for feedback cycle

- doublecheckWaitTime:

    after peak is above max, this time is waiting to check itagain, before applying step

- calibStepSize:

    Size of calibration step

- calibStepNum:

    Number of calibration steps

- calibAverageNum:

    number of peak values to be averaged for each calibration step

- reverseDirection:

    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

- conversionFactor:

    micrometers to femtoseconds conversion factor

- adcValueTimeout:

    if ADC value is not updated within this time, device goesin error state

- amphosAmpli:

    Karabo ID of Amphos Laser Amplifier

- triggerDelayDevice:

    Karabo ID of pplDelayControl device, used to read Pockels cell status

- moveToPlus:

    Move to +x position

- moveToMinus:

    Move to -x position

- moveToZero:

    Move to 0 position

- pathToProgramFiles:

    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

- correctionFile:

    The correction (.ct5) file, including path.

- useExternalTrigger:

    Use external trigger (if true) or auto-run (if false).

- startFromMinusX:

    Set loop initial position to -X

- jumpSpeed:

    The up/down jump speed [bits/ms].

- jumpAmplitude:

    The up/down jump amplitude [bits].

- delayTimePlus:

    Delay time, after moving to position +x.

- delayTimeMinus:

    Delay time, after moving to position -x.

- onTargetTolerance:

    The tolerance [bits] when checking that Galvo is on target position.

- onTargetPlus:

    Galvo is currently at +x position _and_ not moving.

- onTargetMinus:

    Galvo is currently at -x position _and_ not moving.

- laserOn:

    The value of the LASERON signal.

- digitalOut1:

    The value of the DIGITAL OUT1 signal.

- stopEventCode:

    Stop event code.

- galvoTemperature:

    Galvanometer scanner temperature.

- servoTemperature:

    Servo board temperature.

- agcVoltage:

    AGC voltage (PD supply voltage).

- dspCoreVoltage:

    DSP core supply voltage (1.8 V).

- dspIoVoltage:

    DSP IO voltage (3.3 V).

- analogSectVoltage:

    Analog section voltage (9 V).

- adConverterVoltage:

    AD converter supply voltage (5 V).

- galvoHeatingOut:

    Relative heating output of the corresponding galvanometer scanner heater.

- beamline:

    Beamline where to operate

- timingDevice:

    Device ID of PPL Delay Control Device

- galvoDevice:

    id of Galvo Controller

- downstreamSpectr1Device:

    Spectrometer 1 (FXE/SCS)

- upstreamSpectr1Device:

    Spectrometer 1 (SPB/SQS)

- currentExperiment:

    Current MASTER experiment (UPSTREAM or DOWNSTREAM)

- currentVersion:

    Current version

- correctionFactorMaster:

    Correction Factor Master

- correctionFactorSlave:

    Correction Factor Slave

- switchProgress:

    Switching Progress

- switchExperiment:

    Procedure to automatically swap between FXE and SPB delay control and Galvo settings

- on:

    Instructs the device to switch on

- off:

    Instructs device to switch off

- lastError:

    Last error message received. Time is set by front-end firmware.

- scpiTimeout:

    The SCPI communication timeout.

- baseFreq:

    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

- frontendReset:

    send reset command

- s7ack:

    acknowledge to s7 command

- s8ack:

    acknowledge to s8 command

- s9ack:

    acknowledge to s9 command

- laserEmission:

    True when laser ON, false when OFF

- generalStatus:

    True = OK, False = not OK

- temperatureStatus:

    True = OK, False = not OK

- delayBoardStatus:

    True = OK, False = not OK

- inputPin0Status:

    True = OK, False = not OK

- inputPin4Status:

    True = OK, False = not OK

- pd1Voltage:

    Photodiode 1 (TAB 2) voltage

- pd1VoltageAverage:

    Averaged PD1 (TAB 2) voltage

- pd2Voltage:

    Photodiode 2 (TAB 5) voltage

- pd2VoltageAverage:

    Averaged PD2 (TAB 5) voltage

- pd3Voltage:

    PD3 (SPCO 1) voltage

- pd3VoltageAverage:

    Averaged PD3 (SPCO 1) voltage

- pd4Voltage:

    PD4 (TAB 7) voltage

- pd4VoltageAverage:

    Averaged PD4 (TAB 7) voltage

- pd5Voltage:

    PD5 (SPCO2) voltage

- pd5VoltageAverage:

    Averaged PD5 (SPCO2) voltage

- pd6Voltage:

    PD6 voltage

- pd6VoltageAverage:

    Averaged PD6 voltage

- pd7Voltage:

    PD7 voltage

- pd7VoltageAverage:

    Averaged PD7 voltage

- pd8Voltage:

    PD8 voltage

- pd8VoltageAverage:

    Averaged PD8 voltage

- seederOutPower:

    photodiode 1

- xf1OutPower:

    Photodiode 7

- xf2OutPower:

    Photodiode 8

- seederStatus:

    True = OK, False = not OK

- generalSeederStatus:

    True = OK, False = not OK

- hiltiErrorStatus:

    True = OK, False = not OK

- remoteControl:

    if it is false we cannot see it

- regOnOff0:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- regOnOff1:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- setpAX0:

    Variable SetpAx[0] define the setpoint of the servo loop.

- setpAY0:

    Variable SetpAy[0] define the setpoint of the servo loop.

- sumA0:

    Sum signal of angle detector ‘A’

- sumB0:

    Sum signal of position detector ‘B’

- aX0:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY0:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX0:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY0:

    Variable By represents the measured position deviation in y direction from zero position

- rAX0:

    Regulator Output Ax

- rAY0:

    Regulator Output Ay

- rBX0:

    Regulator Output Bx

- rBY0:

    Regulator Output By

- rAXM0:

    Regulator Output AxM

- rAYM0:

    Regulator Output AyM

- rBXM0:

    Regulator Output BxM

- rBYM0:

    Regulator Output ByM

- setpAX1:

    Variable SetpAx[1] define the setpoint of the servo loop.

- setpAY1:

    Variable SetpAy[1] define the setpoint of the servo loop.

- sumA1:

    Sum signal of angle detector ‘A’

- sumB1:

    Sum signal of position detector ‘B’

- aX1:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY1:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX1:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY1:

    Variable By represents the measured position deviation in y direction from zero position

- rAX1:

    Regulator Output Ax

- rAY1:

    Regulator Output Ay

- rBX1:

    Regulator Output Bx

- rBY1:

    Regulator Output By

- rAXM1:

    Regulator Output AxM

- rAYM1:

    Regulator Output AyM

- rBXM1:

    Regulator Output BxM

- rBYM1:

    Regulator Output ByM

- stage1Id:

    Karabo device ID of first grating motor

- stage2Id:

    Karabo device ID of first grating motor

- tunnel:

    Location where doocs_device is deployed (e.g. ‘SASE1’)

- labx2MName:

    DOOCS name of X2 Master doocs_device

- labx2SName:

    DOOCS name of X2 Slave doocs_device

- timingShifterName:

    DOOCS name of Phase Shifter doocs_device

- manualTuning:

    Manual Tuning Enable

- useShifter:

    Set to True if optical synchronization is available

- midTsValue:

    Mid Value of Phase Shifter

- maxTsDelay:

    Maximum delay to add/subtract to phase shifter position

- maxTsJitter:

    Maximum allowed jitter

- laserOpModeList:

    Select Laser Op Mode

- activeLaserOpMode:

    Active Op laser Mode

- laserOpModeListApply:

    Apply Laser Operation Mode

- dmBCCAuto:

    Automatic loop on/off

- pCellState:

    Status of Pockels Cell, True = On

- pCellOn:

    Set Pockels cell on

- pCellOff:

    Set Pockels cell off

- AOMState:

    Status of AOM, True = On

- AOMOn:

    Set AOM on

- AOMOff:

    Set AOM off

- maxAllowedPcPhase:

    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

- mPCCLKPhase:

    Master PC Phase

- mSWPCCLKPhase:

    Master SW PC Phase

- mBurstWidth:

    Master burst width [us]

- mBurstWidthApply:

    Apply m Burst Width

- mBurstStart:

    Begining of the bursts the slave burst is +50ms)

- mBurstStartsms:

    Master burst starts pos. [us]

- sBurstStartsms:

    Sleve burst starts pos. [us]

- smBurstDiff:

    Different between muster and slave burst positione

- sPCCLKPhase:

    Master PC Phase

- sSWPCCLKPhase:

    Slave software PC PHase

- sBurstWidth:

    Slave burst width [us]

- sBurstWidthApply:

    Apply S Burst width

- delayBPMaster:

    Current delay of the master bunch pattern in clock unit (machine)

- delayBPMasterP:

    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterM:

    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterP24:

    Increment Master Bunch Pattern delay by 24 clock unit

- delayBPMasterM24:

    Decrement Master Bunch Pattern delay by 24 clock unit

- delayBPSlave:

    Current delay of the slave bunch pattern in clock unit (machine)

- delayBPSlaveP:

    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveM:

    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveP24:

    Increment Slave Bunch Pattern delay by 24 clock unit

- delayBPSlaveM24:

    Decrement Slave Bunch Pattern delay by 24 clock unit

- masterExpPattern:

    Select pattern for master experiment

- slaveExpPattern:

    Select pattern for slave experiment

- currentLaserPatterns:

    Current Laser Patterns

- currentMasterLaserPattern:

    Current Master Laser Patterns

- currentSlaveLaserPattern:

    Current Slave Laser Patterns

- currentSlaveLaserPatternN:

    Current Slave Laser Pattern

- fineDelayMaxCounts:

    Fine delay - maximum count number

- fineDelayValue:

    fine delay count value

- fineDelayValueT:

    fine delay time value

- fineDelayP:

    Increment fine delay

- fineDelayM:

    Decrement fine delay

- fineDelay9nsChange:

    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

- fineDelay9ns:

    Change Fine Delay by 9 ns

- minTsPosition:

    Minimum Timing Shifter Delay

- maxTsPosition:

    Maximum Timing Shifter Delay

- currentTsPosition:

    current value of time shifter position

- requestedTsDelay:

    Delay to apply to the phase shifter

- DelayTsChange:

    Change phase shifter by requested value

- relAbsolutTsPos:

    True for relative, False for absolute

- stopPsChange:

    Abort phase shift change

- opticalSynch:

    Display status of optical synchronization

- opticalSynchLock:

    Display lock status of optical synchronization

- opticalSynchJitter:

    Display status of optical synchronization jitter

- opticalSynchMode:

    Optical synch. mode (RF / Optical)

- setOpticalDelay:

    Delay to apply to optical delay line

- applyOpticalDelay:

    change the optical delay by requeste value

- currentOpticalDelay:

    Current position of optical delay

- relAbsolutDelayLine:

    True for relative, False for absolute

- TsJitter:

    Optical Synchronization Jitter

- triggerFE_DOWNSTREAM:

    Current trigger delay FE DOWNSTREAM

- triggerFE_UPSTREAM:

    Current trigger delay FE UPSTREAM

- getCurrentHardwareStatus:

    Read configuration from hardware

- lastShiftDelay:

    FE delay value from the prevoius shift

- setLastShiftDelay:

    Bring the delay to position from the previus shift

- clearLock:

    In case of STATE == changing bring the state to Normal

- mPCCLKPhaseSetValue:

    Master PC CLK Phase Value

- sPCCLKPhaseSetValue:

    Slave PC CLK Phase Value

- delayBPMasterSetValue:

    Master BP delay Value

- delayBPSlaveSetValue:

    Slave BP delay Value

- resetError:

    Reset error state

- upstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for upstream instrument

- downstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for downstream instrument

- shiftChange:

    Swaps MASTER and SLAVE properties between upstream and downstream instrument

- isOxcActive:

    Status of optical lock (True: OPTICAL mode, False: RF mode)

- requestedDelay:

    Relative delay to be applied by delay change (Trigger Position)

- delayChange:

    Change delay value by applying (relative) offset

- mPCCLKPhaseP:

    Increment PC master Phase

- mPCCLKPhaseM:

    Decrement PC master Phase

- sPCCLKPhaseP:

    Increment slave PC Phase

- sPCCLKPhaseM:

    Decrement slave PC phase

- savemSWPCCLKPhase:

    Save new software phase value for PCm

- savesSWPCCLKPhase:

    Save new software phase value for PCs

- mBurstStartApply:

    Apply Burst Start Pos

- takemidTsValue:

    Take mid value of phase shifter

- logBoardsStatus:

    JSON string describing master and slave board settings.Usually updated when user actions are taken

- logFineDelay:

    JSON string describing fine delay settings.Usually updated when user actions are taken

- imgprocDevice:

    Device ID of image processor used for feedback

- temDevice:

    id of tem device

- temChannel:

    TEM channel to be controlled

- xCoefWeight:

    weight of X coefficient

- yCoefWeight:

    weight of Y coefficient

- axCoefOld:

    Value of Ax Coefficient saved prior to calibration

- ayCoefOld:

    Value of Ay Coefficient saved prior to calibration

- xBeamCenterTarget:

    desired value for Beam Center X coordinate

- yBeamCenterTarget:

    desired value for Beam Center Y coordinate

- beamCenterMaxDisplacement:

    maximum allowed displacement for Center of Mass from target position

- maxTemDrift:

    Maximum value allowed for TEM drift

- averageNumber:

    number of values of beam center coordinates to average

- timeoutImageProcessorValues:

    Time to wait before going in error when values from image processor are not updating

- imageSettlementTime:

    Time to wait before reading beam center coordinates aftermoving TEM setpoint

- calibrationStep:

    TEM setpoint step size for calibration

- calibrationStepsNumber:

    Number of TEM calibration steps

- maxTimeNotRegulating:

    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

- setCurrentPosAsTarget:

    Set current beam position as target

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

- enableLatchInternal:

    Enables the storage of the value of the scale latched to the internal reference

- enableLatchExternal:

    Enables the storage of the value of the scale latched to the external reference

- adcValue:

    The integer value read out by the encoder

- factor:

    Calibration factor to target unit

- setCounter16:

    Set value for 16 bit encoder.

- setCounter32:

    Set value for 32 bit encoder.

- ssiCoding:

    Binary coding or grey coding. False - Binary; True - Grey

- ssiFrameType:

    Length of the SSI data frame.

- ssiFrameSize:

    Not documented.

- ssiDataLength:

    Not documented.

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

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

###### DMCOMPSTAGE

Instance id: | LA1_LAS_PPL/ENC/DMCOMPSTAGE
Host: | exflcon14n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

Device Schema Description

- _serverId_:

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

- _deviceId_:

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

- _connection_:

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

- visibility:

    Configures who is allowed to see this device at all

- deviceId:

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

- classId:

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

- classVersion:

    The version of the class of this device defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- alarmCondition:

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

- lastCommand:

    The last slot called.

- archive:

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

- useTimeserver:

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

- progress:

    The progress of the current action

- heartbeatInterval:

    The heartbeat interval

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

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

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

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

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

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

- epsilon:

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

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

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

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

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

- maxStateUpdateRate:

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

- noisyStateUpdateRateValue:

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

- isStateUpdateNoisy:

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

- reset:

    Resets the PLC hardware

- enableInterlockedSlots:

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

- disableInterlockedSlots:

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

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

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

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

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

- readHardware:

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

- force:

    ???

- trigger:

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

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- value:

    Encoder read value

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

- start:

    Instructs device to go to started state

- stop:

    Instructs device to go to stopped state

- resetADC:

    Reset ADC’s of FPGA in case of constant line, No signal

- resetDDR2:

    Resets DDR2 in case of constant line, No signal

- deviceFile:

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

- mapDirectory:

    Folder where all xml mapping files are located.

- numberRawSamples:

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

- delay:

    Delay between calibration images.

- skipSamples:

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

- triggerTime:

    Time between Triggers

- triggerTimeStat:

    Histogram of time between Triggers

- trainId:

    Current train ID as read from the FPGA

- config:

    Board related configuration parameters.

- dacNode:

    Set up DAC parameters

- channel_0:

    This is a channel of bunch of other parameters

- channel_1:

    This is a channel of bunch of other parameters

- channel_2:

    This is a channel of bunch of other parameters

- channel_3:

    This is a channel of bunch of other parameters

- channel_4:

    This is a channel of bunch of other parameters

- channel_5:

    This is a channel of bunch of other parameters

- channel_6:

    This is a channel of bunch of other parameters

- channel_7:

    This is a channel of bunch of other parameters

- channel_8:

    This is a channel of bunch of other parameters

- channel_9:

    This is a channel of bunch of other parameters

- semiRawValue:

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

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- timeServerId:

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

- Logger:

    Logging settings

- sendCommand:

    Send command to the instrument.

- replyToCommand:

    Reply to the command send to the instrument.

- gotoErrorOnPollFailure:

    Instrument will go to error if poll fails for all properties.

- autoConnect:

    Set True to automatically connect to device.

- pollingInterval:

    The interval for polling the instrument.

- enableHeartbeat:

    Enable Heartbeat

- heartbeatCommand:

    Text to send as heartbeat

- heartbeatReply:

    Heartbeat reply text

- heartbeatPeriod:

    Heartbeat period

- heartbeatTime:

    Last heartbeat time

- pollingTimeTaken:

    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

- pollNow:

    Poll instrument now!

- _connect_:

    Connects to the device

- disconnect:

    Disconnects from the device

- handshake:

    Set the state of the message roundtrip handshaking.

- baudRate:

    Set the transmit and receive baud rates on the RS-232 port.

- errorCount:

    The number of error records in the queue.

- measureType:

    Set the meter measurement mode (energy or power).

- statisticsMode:

    Set the statistics processing mode (on or off).

- variableDecimation:

    Set the pulse decimation rate (1-99999).

- apertureDiameter:

    Set the aperture diameter.

- wavelength:

    Set the current wavelength.

- gainCompensation:

    Enables or disables the gain compensation.

- gainFactor:

    Set the gain compensation factor.

- range:

    Set the measurement range (maximum expected measurement).

- batchSize:

    Set the statistics batch size.

- restartMode:

    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

- statStart:

    Terminates the current statistical batch and start a new one.

- statStop:

    Terminates the current statistical batch.

- triggerSource:

    Selects the trigger source (INTernal / EXTernal).

- triggerLevel:

    Set the trigger level (no effect when external trigger is selected).

- triggerSlope:

    Selects the external trigger edge (POSitive / NEGative).

- sequenceId:

    Set the sequence ID.

- triggerBus:

    Selects the trigger bus participation mode.

- itemSelect:

    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

- statItemSelect:

    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

- serialNumber:

    The serial number string.

- partNumber:

    The part number.

- modelName:

    The Model Name.

- calibrationDate:

    The calibration date.

- manifacturingDate:

    The manifacturing date.

- defaultWavelength:

    The default wavelength.

- measurementRefreshRate:

    The refresh rate of measurements.

- measurement:

    Last measurement.

- idType:

    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

- cameraId:

    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

- packetDelay:

    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

- autoPacketSize:

    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

- packetSize:

    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

- exposureTime:

    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

- triggerMode:

    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

- triggerActivation:

    This enumeration sets the signal transition needed to activate the selected trigger.

- autoGain:

    Configures automatic gain feature.

- gain:

    Sets the gain of the ADC converter.

- acquisitionMode:

    This property sets the image acquisition mode.

- frameCount:

    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

- xPeak1:

    x-position of peak in first calibration image.

- xFWHM1:

    x-FWHM in first calibration image.

- xPeak2:

    x-position of peak in second calibration image.

- xFWHM2:

    x-FWHM in second calibration image.

- delayUnit:

    Unit of the delay between calibration images.

- useAsCalibrationImage1:

    Use the current image as 1st calibration image.

- useAsCalibrationImage2:

    Use the current image as 2nd calibration image.

- calibrate:

  > perform calibrationStepsNumber steps of calibrationStep size starting and ending in symmetrical places relatively to initial position, both along X and Y, while measuring center of beam position.

  > Use these measurements to calculate axCoef and ayCoef.

  > Assumptions that are made: sin(x) ~= x x(y) axis of TEM parallel to x (y) axis of camera

- calibrationFactor:

    The calibration constant.

- beamShape:

    Time shape of the beam.

- xMinFit:

    Lower limit for the fit.

- xMaxFit:

    Upper limit for the fit.

- fitStatus:

    Error of fit procedure: 1-3 means good fit. See device documentation for further details.

- subtractPedestal:

    Subtract the pedestal, calculated from linear interpolation between first and last point.

- xPeak3:

    x-position of peak in the input image.

- xFWHM3:

    x-FWHM in the input image.

- pulseWidth:

    Duration of the pulse.

- ePulseWidth:

    Uncertainty of the pulse duration arising from fit procedure.

- switchToReady:

    Instructs the amplifier to go to ready state.

- switchOn:

    Instructs the amplifier to go to on state.

- switchOff:

    Instructs the amplifier to go to off state.

- closeShutter2:

    Instructs the amplifier to close Shutter 2.

- openShutter2:

    Instructs the amplifier to open Shutter 2.

- amphosIp:

    The IP address of the Amphos Control.

- amphosPort:

    The port of the Amphos Control.

- stateChanging:

    Laser is currently changing state.

- targetPower:

    Target laser power.

- chillerTemperature:

    Measured temperature of chiller.

- chillerFlow:

    Measured flow of chiller [l/min].

- chillerValvePosition:

    Measured valve position.

- shutter2IsOpen:

    Shutter2 State: False=closed True=open

- lambdaIsBusy:

    Lambda plate is moving.

- laserCurrent:

    Measured current of Amphos400.

- laserTemperature:

    Measured temperature of Amphos400.

- laserHumidity:

    Measured humidity of Amphos400.

- xfelCurrentCW1:

    Measured current of XFEL booster 1 (CW1).

- xfelCurrentCW2:

    Measured current of XFEL booster 1 (CW2).

- xfelCurrentQCW1:

    Measured current of XFEL booster 1 (QCW1).

- xfelCurrentQCW2:

    Measured current of XFEL booster 1 (QCW2).

- xfelCurrentQCW3:

    Measured current of XFEL booster 1 (QCW3).

- xfelCurrentQCW4:

    Measured current of XFEL booster 1 (QCW3).

- xfelTemperature:

    Measured temperature of XFEL booster 1.

- xfelHumidity:

    Measured humidity of XFEL booster 1.

- globalAlarmCondition:

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

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- log:

    Logging settings

- adc:

    fast ADC input device

- selectedAdcChannel:

    fast ADC channel in use for the loop

- maxPeakValue:

    Max absolute value for ADC peak. When peak is above this value step is applied

- tuneStage:

    motor controlling the stage to adjust laser path

- stageStep:

    value of stage tuning step size

- loopPeriod:

    Time interval for feedback cycle

- doublecheckWaitTime:

    after peak is above max, this time is waiting to check itagain, before applying step

- calibStepSize:

    Size of calibration step

- calibStepNum:

    Number of calibration steps

- calibAverageNum:

    number of peak values to be averaged for each calibration step

- reverseDirection:

    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

- conversionFactor:

    micrometers to femtoseconds conversion factor

- adcValueTimeout:

    if ADC value is not updated within this time, device goesin error state

- amphosAmpli:

    Karabo ID of Amphos Laser Amplifier

- triggerDelayDevice:

    Karabo ID of pplDelayControl device, used to read Pockels cell status

- moveToPlus:

    Move to +x position

- moveToMinus:

    Move to -x position

- moveToZero:

    Move to 0 position

- pathToProgramFiles:

    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

- correctionFile:

    The correction (.ct5) file, including path.

- useExternalTrigger:

    Use external trigger (if true) or auto-run (if false).

- startFromMinusX:

    Set loop initial position to -X

- jumpSpeed:

    The up/down jump speed [bits/ms].

- jumpAmplitude:

    The up/down jump amplitude [bits].

- delayTimePlus:

    Delay time, after moving to position +x.

- delayTimeMinus:

    Delay time, after moving to position -x.

- onTargetTolerance:

    The tolerance [bits] when checking that Galvo is on target position.

- onTargetPlus:

    Galvo is currently at +x position _and_ not moving.

- onTargetMinus:

    Galvo is currently at -x position _and_ not moving.

- laserOn:

    The value of the LASERON signal.

- digitalOut1:

    The value of the DIGITAL OUT1 signal.

- stopEventCode:

    Stop event code.

- galvoTemperature:

    Galvanometer scanner temperature.

- servoTemperature:

    Servo board temperature.

- agcVoltage:

    AGC voltage (PD supply voltage).

- dspCoreVoltage:

    DSP core supply voltage (1.8 V).

- dspIoVoltage:

    DSP IO voltage (3.3 V).

- analogSectVoltage:

    Analog section voltage (9 V).

- adConverterVoltage:

    AD converter supply voltage (5 V).

- galvoHeatingOut:

    Relative heating output of the corresponding galvanometer scanner heater.

- beamline:

    Beamline where to operate

- timingDevice:

    Device ID of PPL Delay Control Device

- galvoDevice:

    id of Galvo Controller

- downstreamSpectr1Device:

    Spectrometer 1 (FXE/SCS)

- upstreamSpectr1Device:

    Spectrometer 1 (SPB/SQS)

- currentExperiment:

    Current MASTER experiment (UPSTREAM or DOWNSTREAM)

- currentVersion:

    Current version

- correctionFactorMaster:

    Correction Factor Master

- correctionFactorSlave:

    Correction Factor Slave

- switchProgress:

    Switching Progress

- switchExperiment:

    Procedure to automatically swap between FXE and SPB delay control and Galvo settings

- on:

    Instructs the device to switch on

- off:

    Instructs device to switch off

- lastError:

    Last error message received. Time is set by front-end firmware.

- scpiTimeout:

    The SCPI communication timeout.

- baseFreq:

    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

- frontendReset:

    send reset command

- s7ack:

    acknowledge to s7 command

- s8ack:

    acknowledge to s8 command

- s9ack:

    acknowledge to s9 command

- laserEmission:

    True when laser ON, false when OFF

- generalStatus:

    True = OK, False = not OK

- temperatureStatus:

    True = OK, False = not OK

- delayBoardStatus:

    True = OK, False = not OK

- inputPin0Status:

    True = OK, False = not OK

- inputPin4Status:

    True = OK, False = not OK

- pd1Voltage:

    Photodiode 1 (TAB 2) voltage

- pd1VoltageAverage:

    Averaged PD1 (TAB 2) voltage

- pd2Voltage:

    Photodiode 2 (TAB 5) voltage

- pd2VoltageAverage:

    Averaged PD2 (TAB 5) voltage

- pd3Voltage:

    PD3 (SPCO 1) voltage

- pd3VoltageAverage:

    Averaged PD3 (SPCO 1) voltage

- pd4Voltage:

    PD4 (TAB 7) voltage

- pd4VoltageAverage:

    Averaged PD4 (TAB 7) voltage

- pd5Voltage:

    PD5 (SPCO2) voltage

- pd5VoltageAverage:

    Averaged PD5 (SPCO2) voltage

- pd6Voltage:

    PD6 voltage

- pd6VoltageAverage:

    Averaged PD6 voltage

- pd7Voltage:

    PD7 voltage

- pd7VoltageAverage:

    Averaged PD7 voltage

- pd8Voltage:

    PD8 voltage

- pd8VoltageAverage:

    Averaged PD8 voltage

- seederOutPower:

    photodiode 1

- xf1OutPower:

    Photodiode 7

- xf2OutPower:

    Photodiode 8

- seederStatus:

    True = OK, False = not OK

- generalSeederStatus:

    True = OK, False = not OK

- hiltiErrorStatus:

    True = OK, False = not OK

- remoteControl:

    if it is false we cannot see it

- regOnOff0:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- regOnOff1:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- setpAX0:

    Variable SetpAx[0] define the setpoint of the servo loop.

- setpAY0:

    Variable SetpAy[0] define the setpoint of the servo loop.

- sumA0:

    Sum signal of angle detector ‘A’

- sumB0:

    Sum signal of position detector ‘B’

- aX0:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY0:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX0:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY0:

    Variable By represents the measured position deviation in y direction from zero position

- rAX0:

    Regulator Output Ax

- rAY0:

    Regulator Output Ay

- rBX0:

    Regulator Output Bx

- rBY0:

    Regulator Output By

- rAXM0:

    Regulator Output AxM

- rAYM0:

    Regulator Output AyM

- rBXM0:

    Regulator Output BxM

- rBYM0:

    Regulator Output ByM

- setpAX1:

    Variable SetpAx[1] define the setpoint of the servo loop.

- setpAY1:

    Variable SetpAy[1] define the setpoint of the servo loop.

- sumA1:

    Sum signal of angle detector ‘A’

- sumB1:

    Sum signal of position detector ‘B’

- aX1:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY1:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX1:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY1:

    Variable By represents the measured position deviation in y direction from zero position

- rAX1:

    Regulator Output Ax

- rAY1:

    Regulator Output Ay

- rBX1:

    Regulator Output Bx

- rBY1:

    Regulator Output By

- rAXM1:

    Regulator Output AxM

- rAYM1:

    Regulator Output AyM

- rBXM1:

    Regulator Output BxM

- rBYM1:

    Regulator Output ByM

- stage1Id:

    Karabo device ID of first grating motor

- stage2Id:

    Karabo device ID of first grating motor

- tunnel:

    Location where doocs_device is deployed (e.g. ‘SASE1’)

- labx2MName:

    DOOCS name of X2 Master doocs_device

- labx2SName:

    DOOCS name of X2 Slave doocs_device

- timingShifterName:

    DOOCS name of Phase Shifter doocs_device

- manualTuning:

    Manual Tuning Enable

- useShifter:

    Set to True if optical synchronization is available

- midTsValue:

    Mid Value of Phase Shifter

- maxTsDelay:

    Maximum delay to add/subtract to phase shifter position

- maxTsJitter:

    Maximum allowed jitter

- laserOpModeList:

    Select Laser Op Mode

- activeLaserOpMode:

    Active Op laser Mode

- laserOpModeListApply:

    Apply Laser Operation Mode

- dmBCCAuto:

    Automatic loop on/off

- pCellState:

    Status of Pockels Cell, True = On

- pCellOn:

    Set Pockels cell on

- pCellOff:

    Set Pockels cell off

- AOMState:

    Status of AOM, True = On

- AOMOn:

    Set AOM on

- AOMOff:

    Set AOM off

- maxAllowedPcPhase:

    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

- mPCCLKPhase:

    Master PC Phase

- mSWPCCLKPhase:

    Master SW PC Phase

- mBurstWidth:

    Master burst width [us]

- mBurstWidthApply:

    Apply m Burst Width

- mBurstStart:

    Begining of the bursts the slave burst is +50ms)

- mBurstStartsms:

    Master burst starts pos. [us]

- sBurstStartsms:

    Sleve burst starts pos. [us]

- smBurstDiff:

    Different between muster and slave burst positione

- sPCCLKPhase:

    Master PC Phase

- sSWPCCLKPhase:

    Slave software PC PHase

- sBurstWidth:

    Slave burst width [us]

- sBurstWidthApply:

    Apply S Burst width

- delayBPMaster:

    Current delay of the master bunch pattern in clock unit (machine)

- delayBPMasterP:

    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterM:

    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterP24:

    Increment Master Bunch Pattern delay by 24 clock unit

- delayBPMasterM24:

    Decrement Master Bunch Pattern delay by 24 clock unit

- delayBPSlave:

    Current delay of the slave bunch pattern in clock unit (machine)

- delayBPSlaveP:

    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveM:

    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveP24:

    Increment Slave Bunch Pattern delay by 24 clock unit

- delayBPSlaveM24:

    Decrement Slave Bunch Pattern delay by 24 clock unit

- masterExpPattern:

    Select pattern for master experiment

- slaveExpPattern:

    Select pattern for slave experiment

- currentLaserPatterns:

    Current Laser Patterns

- currentMasterLaserPattern:

    Current Master Laser Patterns

- currentSlaveLaserPattern:

    Current Slave Laser Patterns

- currentSlaveLaserPatternN:

    Current Slave Laser Pattern

- fineDelayMaxCounts:

    Fine delay - maximum count number

- fineDelayValue:

    fine delay count value

- fineDelayValueT:

    fine delay time value

- fineDelayP:

    Increment fine delay

- fineDelayM:

    Decrement fine delay

- fineDelay9nsChange:

    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

- fineDelay9ns:

    Change Fine Delay by 9 ns

- minTsPosition:

    Minimum Timing Shifter Delay

- maxTsPosition:

    Maximum Timing Shifter Delay

- currentTsPosition:

    current value of time shifter position

- requestedTsDelay:

    Delay to apply to the phase shifter

- DelayTsChange:

    Change phase shifter by requested value

- relAbsolutTsPos:

    True for relative, False for absolute

- stopPsChange:

    Abort phase shift change

- opticalSynch:

    Display status of optical synchronization

- opticalSynchLock:

    Display lock status of optical synchronization

- opticalSynchJitter:

    Display status of optical synchronization jitter

- opticalSynchMode:

    Optical synch. mode (RF / Optical)

- setOpticalDelay:

    Delay to apply to optical delay line

- applyOpticalDelay:

    change the optical delay by requeste value

- currentOpticalDelay:

    Current position of optical delay

- relAbsolutDelayLine:

    True for relative, False for absolute

- TsJitter:

    Optical Synchronization Jitter

- triggerFE_DOWNSTREAM:

    Current trigger delay FE DOWNSTREAM

- triggerFE_UPSTREAM:

    Current trigger delay FE UPSTREAM

- getCurrentHardwareStatus:

    Read configuration from hardware

- lastShiftDelay:

    FE delay value from the prevoius shift

- setLastShiftDelay:

    Bring the delay to position from the previus shift

- clearLock:

    In case of STATE == changing bring the state to Normal

- mPCCLKPhaseSetValue:

    Master PC CLK Phase Value

- sPCCLKPhaseSetValue:

    Slave PC CLK Phase Value

- delayBPMasterSetValue:

    Master BP delay Value

- delayBPSlaveSetValue:

    Slave BP delay Value

- resetError:

    Reset error state

- upstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for upstream instrument

- downstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for downstream instrument

- shiftChange:

    Swaps MASTER and SLAVE properties between upstream and downstream instrument

- isOxcActive:

    Status of optical lock (True: OPTICAL mode, False: RF mode)

- requestedDelay:

    Relative delay to be applied by delay change (Trigger Position)

- delayChange:

    Change delay value by applying (relative) offset

- mPCCLKPhaseP:

    Increment PC master Phase

- mPCCLKPhaseM:

    Decrement PC master Phase

- sPCCLKPhaseP:

    Increment slave PC Phase

- sPCCLKPhaseM:

    Decrement slave PC phase

- savemSWPCCLKPhase:

    Save new software phase value for PCm

- savesSWPCCLKPhase:

    Save new software phase value for PCs

- mBurstStartApply:

    Apply Burst Start Pos

- takemidTsValue:

    Take mid value of phase shifter

- logBoardsStatus:

    JSON string describing master and slave board settings.Usually updated when user actions are taken

- logFineDelay:

    JSON string describing fine delay settings.Usually updated when user actions are taken

- imgprocDevice:

    Device ID of image processor used for feedback

- temDevice:

    id of tem device

- temChannel:

    TEM channel to be controlled

- xCoefWeight:

    weight of X coefficient

- yCoefWeight:

    weight of Y coefficient

- axCoefOld:

    Value of Ax Coefficient saved prior to calibration

- ayCoefOld:

    Value of Ay Coefficient saved prior to calibration

- xBeamCenterTarget:

    desired value for Beam Center X coordinate

- yBeamCenterTarget:

    desired value for Beam Center Y coordinate

- beamCenterMaxDisplacement:

    maximum allowed displacement for Center of Mass from target position

- maxTemDrift:

    Maximum value allowed for TEM drift

- averageNumber:

    number of values of beam center coordinates to average

- timeoutImageProcessorValues:

    Time to wait before going in error when values from image processor are not updating

- imageSettlementTime:

    Time to wait before reading beam center coordinates aftermoving TEM setpoint

- calibrationStep:

    TEM setpoint step size for calibration

- calibrationStepsNumber:

    Number of TEM calibration steps

- maxTimeNotRegulating:

    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

- setCurrentPosAsTarget:

    Set current beam position as target

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

- enableLatchInternal:

    Enables the storage of the value of the scale latched to the internal reference

- enableLatchExternal:

    Enables the storage of the value of the scale latched to the external reference

- adcValue:

    The integer value read out by the encoder

- factor:

    Calibration factor to target unit

- setCounter16:

    Set value for 16 bit encoder.

- setCounter32:

    Set value for 32 bit encoder.

- ssiCoding:

    Binary coding or grey coding. False - Binary; True - Grey

- ssiFrameType:

    Length of the SSI data frame.

- ssiFrameSize:

    Not documented.

- ssiDataLength:

    Not documented.

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

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

###### NANOSSPARE1

Instance id: | LA1_LAS_PPL/ENC/NANOSSPARE1
Host: | exflcon14n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

Device Schema Description

- _serverId_:

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

- _deviceId_:

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

- _connection_:

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

- visibility:

    Configures who is allowed to see this device at all

- deviceId:

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

- classId:

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

- classVersion:

    The version of the class of this device defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- alarmCondition:

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

- lastCommand:

    The last slot called.

- archive:

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

- useTimeserver:

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

- progress:

    The progress of the current action

- heartbeatInterval:

    The heartbeat interval

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

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

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

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

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

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

- epsilon:

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

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

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

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

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

- maxStateUpdateRate:

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

- noisyStateUpdateRateValue:

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

- isStateUpdateNoisy:

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

- reset:

    Resets the PLC hardware

- enableInterlockedSlots:

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

- disableInterlockedSlots:

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

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

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

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

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

- readHardware:

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

- force:

    ???

- trigger:

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

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- value:

    Encoder read value

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

- start:

    Instructs device to go to started state

- stop:

    Instructs device to go to stopped state

- resetADC:

    Reset ADC’s of FPGA in case of constant line, No signal

- resetDDR2:

    Resets DDR2 in case of constant line, No signal

- deviceFile:

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

- mapDirectory:

    Folder where all xml mapping files are located.

- numberRawSamples:

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

- delay:

    Delay between calibration images.

- skipSamples:

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

- triggerTime:

    Time between Triggers

- triggerTimeStat:

    Histogram of time between Triggers

- trainId:

    Current train ID as read from the FPGA

- config:

    Board related configuration parameters.

- dacNode:

    Set up DAC parameters

- channel_0:

    This is a channel of bunch of other parameters

- channel_1:

    This is a channel of bunch of other parameters

- channel_2:

    This is a channel of bunch of other parameters

- channel_3:

    This is a channel of bunch of other parameters

- channel_4:

    This is a channel of bunch of other parameters

- channel_5:

    This is a channel of bunch of other parameters

- channel_6:

    This is a channel of bunch of other parameters

- channel_7:

    This is a channel of bunch of other parameters

- channel_8:

    This is a channel of bunch of other parameters

- channel_9:

    This is a channel of bunch of other parameters

- semiRawValue:

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

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- timeServerId:

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

- Logger:

    Logging settings

- sendCommand:

    Send command to the instrument.

- replyToCommand:

    Reply to the command send to the instrument.

- gotoErrorOnPollFailure:

    Instrument will go to error if poll fails for all properties.

- autoConnect:

    Set True to automatically connect to device.

- pollingInterval:

    The interval for polling the instrument.

- enableHeartbeat:

    Enable Heartbeat

- heartbeatCommand:

    Text to send as heartbeat

- heartbeatReply:

    Heartbeat reply text

- heartbeatPeriod:

    Heartbeat period

- heartbeatTime:

    Last heartbeat time

- pollingTimeTaken:

    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

- pollNow:

    Poll instrument now!

- _connect_:

    Connects to the device

- disconnect:

    Disconnects from the device

- handshake:

    Set the state of the message roundtrip handshaking.

- baudRate:

    Set the transmit and receive baud rates on the RS-232 port.

- errorCount:

    The number of error records in the queue.

- measureType:

    Set the meter measurement mode (energy or power).

- statisticsMode:

    Set the statistics processing mode (on or off).

- variableDecimation:

    Set the pulse decimation rate (1-99999).

- apertureDiameter:

    Set the aperture diameter.

- wavelength:

    Set the current wavelength.

- gainCompensation:

    Enables or disables the gain compensation.

- gainFactor:

    Set the gain compensation factor.

- range:

    Set the measurement range (maximum expected measurement).

- batchSize:

    Set the statistics batch size.

- restartMode:

    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

- statStart:

    Terminates the current statistical batch and start a new one.

- statStop:

    Terminates the current statistical batch.

- triggerSource:

    Selects the trigger source (INTernal / EXTernal).

- triggerLevel:

    Set the trigger level (no effect when external trigger is selected).

- triggerSlope:

    Selects the external trigger edge (POSitive / NEGative).

- sequenceId:

    Set the sequence ID.

- triggerBus:

    Selects the trigger bus participation mode.

- itemSelect:

    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

- statItemSelect:

    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

- serialNumber:

    The serial number string.

- partNumber:

    The part number.

- modelName:

    The Model Name.

- calibrationDate:

    The calibration date.

- manifacturingDate:

    The manifacturing date.

- defaultWavelength:

    The default wavelength.

- measurementRefreshRate:

    The refresh rate of measurements.

- measurement:

    Last measurement.

- idType:

    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

- cameraId:

    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

- packetDelay:

    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

- autoPacketSize:

    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

- packetSize:

    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

- exposureTime:

    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

- triggerMode:

    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

- triggerActivation:

    This enumeration sets the signal transition needed to activate the selected trigger.

- autoGain:

    Configures automatic gain feature.

- gain:

    Sets the gain of the ADC converter.

- acquisitionMode:

    This property sets the image acquisition mode.

- frameCount:

    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

- xPeak1:

    x-position of peak in first calibration image.

- xFWHM1:

    x-FWHM in first calibration image.

- xPeak2:

    x-position of peak in second calibration image.

- xFWHM2:

    x-FWHM in second calibration image.

- delayUnit:

    Unit of the delay between calibration images.

- useAsCalibrationImage1:

    Use the current image as 1st calibration image.

- useAsCalibrationImage2:

    Use the current image as 2nd calibration image.

- calibrate:

  > perform calibrationStepsNumber steps of calibrationStep size starting and ending in symmetrical places relatively to initial position, both along X and Y, while measuring center of beam position.

  > Use these measurements to calculate axCoef and ayCoef.

  > Assumptions that are made: sin(x) ~= x x(y) axis of TEM parallel to x (y) axis of camera

- calibrationFactor:

    The calibration constant.

- beamShape:

    Time shape of the beam.

- xMinFit:

    Lower limit for the fit.

- xMaxFit:

    Upper limit for the fit.

- fitStatus:

    Error of fit procedure: 1-3 means good fit. See device documentation for further details.

- subtractPedestal:

    Subtract the pedestal, calculated from linear interpolation between first and last point.

- xPeak3:

    x-position of peak in the input image.

- xFWHM3:

    x-FWHM in the input image.

- pulseWidth:

    Duration of the pulse.

- ePulseWidth:

    Uncertainty of the pulse duration arising from fit procedure.

- switchToReady:

    Instructs the amplifier to go to ready state.

- switchOn:

    Instructs the amplifier to go to on state.

- switchOff:

    Instructs the amplifier to go to off state.

- closeShutter2:

    Instructs the amplifier to close Shutter 2.

- openShutter2:

    Instructs the amplifier to open Shutter 2.

- amphosIp:

    The IP address of the Amphos Control.

- amphosPort:

    The port of the Amphos Control.

- stateChanging:

    Laser is currently changing state.

- targetPower:

    Target laser power.

- chillerTemperature:

    Measured temperature of chiller.

- chillerFlow:

    Measured flow of chiller [l/min].

- chillerValvePosition:

    Measured valve position.

- shutter2IsOpen:

    Shutter2 State: False=closed True=open

- lambdaIsBusy:

    Lambda plate is moving.

- laserCurrent:

    Measured current of Amphos400.

- laserTemperature:

    Measured temperature of Amphos400.

- laserHumidity:

    Measured humidity of Amphos400.

- xfelCurrentCW1:

    Measured current of XFEL booster 1 (CW1).

- xfelCurrentCW2:

    Measured current of XFEL booster 1 (CW2).

- xfelCurrentQCW1:

    Measured current of XFEL booster 1 (QCW1).

- xfelCurrentQCW2:

    Measured current of XFEL booster 1 (QCW2).

- xfelCurrentQCW3:

    Measured current of XFEL booster 1 (QCW3).

- xfelCurrentQCW4:

    Measured current of XFEL booster 1 (QCW3).

- xfelTemperature:

    Measured temperature of XFEL booster 1.

- xfelHumidity:

    Measured humidity of XFEL booster 1.

- globalAlarmCondition:

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

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- log:

    Logging settings

- adc:

    fast ADC input device

- selectedAdcChannel:

    fast ADC channel in use for the loop

- maxPeakValue:

    Max absolute value for ADC peak. When peak is above this value step is applied

- tuneStage:

    motor controlling the stage to adjust laser path

- stageStep:

    value of stage tuning step size

- loopPeriod:

    Time interval for feedback cycle

- doublecheckWaitTime:

    after peak is above max, this time is waiting to check itagain, before applying step

- calibStepSize:

    Size of calibration step

- calibStepNum:

    Number of calibration steps

- calibAverageNum:

    number of peak values to be averaged for each calibration step

- reverseDirection:

    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

- conversionFactor:

    micrometers to femtoseconds conversion factor

- adcValueTimeout:

    if ADC value is not updated within this time, device goesin error state

- amphosAmpli:

    Karabo ID of Amphos Laser Amplifier

- triggerDelayDevice:

    Karabo ID of pplDelayControl device, used to read Pockels cell status

- moveToPlus:

    Move to +x position

- moveToMinus:

    Move to -x position

- moveToZero:

    Move to 0 position

- pathToProgramFiles:

    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

- correctionFile:

    The correction (.ct5) file, including path.

- useExternalTrigger:

    Use external trigger (if true) or auto-run (if false).

- startFromMinusX:

    Set loop initial position to -X

- jumpSpeed:

    The up/down jump speed [bits/ms].

- jumpAmplitude:

    The up/down jump amplitude [bits].

- delayTimePlus:

    Delay time, after moving to position +x.

- delayTimeMinus:

    Delay time, after moving to position -x.

- onTargetTolerance:

    The tolerance [bits] when checking that Galvo is on target position.

- onTargetPlus:

    Galvo is currently at +x position _and_ not moving.

- onTargetMinus:

    Galvo is currently at -x position _and_ not moving.

- laserOn:

    The value of the LASERON signal.

- digitalOut1:

    The value of the DIGITAL OUT1 signal.

- stopEventCode:

    Stop event code.

- galvoTemperature:

    Galvanometer scanner temperature.

- servoTemperature:

    Servo board temperature.

- agcVoltage:

    AGC voltage (PD supply voltage).

- dspCoreVoltage:

    DSP core supply voltage (1.8 V).

- dspIoVoltage:

    DSP IO voltage (3.3 V).

- analogSectVoltage:

    Analog section voltage (9 V).

- adConverterVoltage:

    AD converter supply voltage (5 V).

- galvoHeatingOut:

    Relative heating output of the corresponding galvanometer scanner heater.

- beamline:

    Beamline where to operate

- timingDevice:

    Device ID of PPL Delay Control Device

- galvoDevice:

    id of Galvo Controller

- downstreamSpectr1Device:

    Spectrometer 1 (FXE/SCS)

- upstreamSpectr1Device:

    Spectrometer 1 (SPB/SQS)

- currentExperiment:

    Current MASTER experiment (UPSTREAM or DOWNSTREAM)

- currentVersion:

    Current version

- correctionFactorMaster:

    Correction Factor Master

- correctionFactorSlave:

    Correction Factor Slave

- switchProgress:

    Switching Progress

- switchExperiment:

    Procedure to automatically swap between FXE and SPB delay control and Galvo settings

- on:

    Instructs the device to switch on

- off:

    Instructs device to switch off

- lastError:

    Last error message received. Time is set by front-end firmware.

- scpiTimeout:

    The SCPI communication timeout.

- baseFreq:

    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

- frontendReset:

    send reset command

- s7ack:

    acknowledge to s7 command

- s8ack:

    acknowledge to s8 command

- s9ack:

    acknowledge to s9 command

- laserEmission:

    True when laser ON, false when OFF

- generalStatus:

    True = OK, False = not OK

- temperatureStatus:

    True = OK, False = not OK

- delayBoardStatus:

    True = OK, False = not OK

- inputPin0Status:

    True = OK, False = not OK

- inputPin4Status:

    True = OK, False = not OK

- pd1Voltage:

    Photodiode 1 (TAB 2) voltage

- pd1VoltageAverage:

    Averaged PD1 (TAB 2) voltage

- pd2Voltage:

    Photodiode 2 (TAB 5) voltage

- pd2VoltageAverage:

    Averaged PD2 (TAB 5) voltage

- pd3Voltage:

    PD3 (SPCO 1) voltage

- pd3VoltageAverage:

    Averaged PD3 (SPCO 1) voltage

- pd4Voltage:

    PD4 (TAB 7) voltage

- pd4VoltageAverage:

    Averaged PD4 (TAB 7) voltage

- pd5Voltage:

    PD5 (SPCO2) voltage

- pd5VoltageAverage:

    Averaged PD5 (SPCO2) voltage

- pd6Voltage:

    PD6 voltage

- pd6VoltageAverage:

    Averaged PD6 voltage

- pd7Voltage:

    PD7 voltage

- pd7VoltageAverage:

    Averaged PD7 voltage

- pd8Voltage:

    PD8 voltage

- pd8VoltageAverage:

    Averaged PD8 voltage

- seederOutPower:

    photodiode 1

- xf1OutPower:

    Photodiode 7

- xf2OutPower:

    Photodiode 8

- seederStatus:

    True = OK, False = not OK

- generalSeederStatus:

    True = OK, False = not OK

- hiltiErrorStatus:

    True = OK, False = not OK

- remoteControl:

    if it is false we cannot see it

- regOnOff0:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- regOnOff1:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- setpAX0:

    Variable SetpAx[0] define the setpoint of the servo loop.

- setpAY0:

    Variable SetpAy[0] define the setpoint of the servo loop.

- sumA0:

    Sum signal of angle detector ‘A’

- sumB0:

    Sum signal of position detector ‘B’

- aX0:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY0:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX0:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY0:

    Variable By represents the measured position deviation in y direction from zero position

- rAX0:

    Regulator Output Ax

- rAY0:

    Regulator Output Ay

- rBX0:

    Regulator Output Bx

- rBY0:

    Regulator Output By

- rAXM0:

    Regulator Output AxM

- rAYM0:

    Regulator Output AyM

- rBXM0:

    Regulator Output BxM

- rBYM0:

    Regulator Output ByM

- setpAX1:

    Variable SetpAx[1] define the setpoint of the servo loop.

- setpAY1:

    Variable SetpAy[1] define the setpoint of the servo loop.

- sumA1:

    Sum signal of angle detector ‘A’

- sumB1:

    Sum signal of position detector ‘B’

- aX1:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY1:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX1:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY1:

    Variable By represents the measured position deviation in y direction from zero position

- rAX1:

    Regulator Output Ax

- rAY1:

    Regulator Output Ay

- rBX1:

    Regulator Output Bx

- rBY1:

    Regulator Output By

- rAXM1:

    Regulator Output AxM

- rAYM1:

    Regulator Output AyM

- rBXM1:

    Regulator Output BxM

- rBYM1:

    Regulator Output ByM

- stage1Id:

    Karabo device ID of first grating motor

- stage2Id:

    Karabo device ID of first grating motor

- tunnel:

    Location where doocs_device is deployed (e.g. ‘SASE1’)

- labx2MName:

    DOOCS name of X2 Master doocs_device

- labx2SName:

    DOOCS name of X2 Slave doocs_device

- timingShifterName:

    DOOCS name of Phase Shifter doocs_device

- manualTuning:

    Manual Tuning Enable

- useShifter:

    Set to True if optical synchronization is available

- midTsValue:

    Mid Value of Phase Shifter

- maxTsDelay:

    Maximum delay to add/subtract to phase shifter position

- maxTsJitter:

    Maximum allowed jitter

- laserOpModeList:

    Select Laser Op Mode

- activeLaserOpMode:

    Active Op laser Mode

- laserOpModeListApply:

    Apply Laser Operation Mode

- dmBCCAuto:

    Automatic loop on/off

- pCellState:

    Status of Pockels Cell, True = On

- pCellOn:

    Set Pockels cell on

- pCellOff:

    Set Pockels cell off

- AOMState:

    Status of AOM, True = On

- AOMOn:

    Set AOM on

- AOMOff:

    Set AOM off

- maxAllowedPcPhase:

    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

- mPCCLKPhase:

    Master PC Phase

- mSWPCCLKPhase:

    Master SW PC Phase

- mBurstWidth:

    Master burst width [us]

- mBurstWidthApply:

    Apply m Burst Width

- mBurstStart:

    Begining of the bursts the slave burst is +50ms)

- mBurstStartsms:

    Master burst starts pos. [us]

- sBurstStartsms:

    Sleve burst starts pos. [us]

- smBurstDiff:

    Different between muster and slave burst positione

- sPCCLKPhase:

    Master PC Phase

- sSWPCCLKPhase:

    Slave software PC PHase

- sBurstWidth:

    Slave burst width [us]

- sBurstWidthApply:

    Apply S Burst width

- delayBPMaster:

    Current delay of the master bunch pattern in clock unit (machine)

- delayBPMasterP:

    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterM:

    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterP24:

    Increment Master Bunch Pattern delay by 24 clock unit

- delayBPMasterM24:

    Decrement Master Bunch Pattern delay by 24 clock unit

- delayBPSlave:

    Current delay of the slave bunch pattern in clock unit (machine)

- delayBPSlaveP:

    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveM:

    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveP24:

    Increment Slave Bunch Pattern delay by 24 clock unit

- delayBPSlaveM24:

    Decrement Slave Bunch Pattern delay by 24 clock unit

- masterExpPattern:

    Select pattern for master experiment

- slaveExpPattern:

    Select pattern for slave experiment

- currentLaserPatterns:

    Current Laser Patterns

- currentMasterLaserPattern:

    Current Master Laser Patterns

- currentSlaveLaserPattern:

    Current Slave Laser Patterns

- currentSlaveLaserPatternN:

    Current Slave Laser Pattern

- fineDelayMaxCounts:

    Fine delay - maximum count number

- fineDelayValue:

    fine delay count value

- fineDelayValueT:

    fine delay time value

- fineDelayP:

    Increment fine delay

- fineDelayM:

    Decrement fine delay

- fineDelay9nsChange:

    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

- fineDelay9ns:

    Change Fine Delay by 9 ns

- minTsPosition:

    Minimum Timing Shifter Delay

- maxTsPosition:

    Maximum Timing Shifter Delay

- currentTsPosition:

    current value of time shifter position

- requestedTsDelay:

    Delay to apply to the phase shifter

- DelayTsChange:

    Change phase shifter by requested value

- relAbsolutTsPos:

    True for relative, False for absolute

- stopPsChange:

    Abort phase shift change

- opticalSynch:

    Display status of optical synchronization

- opticalSynchLock:

    Display lock status of optical synchronization

- opticalSynchJitter:

    Display status of optical synchronization jitter

- opticalSynchMode:

    Optical synch. mode (RF / Optical)

- setOpticalDelay:

    Delay to apply to optical delay line

- applyOpticalDelay:

    change the optical delay by requeste value

- currentOpticalDelay:

    Current position of optical delay

- relAbsolutDelayLine:

    True for relative, False for absolute

- TsJitter:

    Optical Synchronization Jitter

- triggerFE_DOWNSTREAM:

    Current trigger delay FE DOWNSTREAM

- triggerFE_UPSTREAM:

    Current trigger delay FE UPSTREAM

- getCurrentHardwareStatus:

    Read configuration from hardware

- lastShiftDelay:

    FE delay value from the prevoius shift

- setLastShiftDelay:

    Bring the delay to position from the previus shift

- clearLock:

    In case of STATE == changing bring the state to Normal

- mPCCLKPhaseSetValue:

    Master PC CLK Phase Value

- sPCCLKPhaseSetValue:

    Slave PC CLK Phase Value

- delayBPMasterSetValue:

    Master BP delay Value

- delayBPSlaveSetValue:

    Slave BP delay Value

- resetError:

    Reset error state

- upstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for upstream instrument

- downstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for downstream instrument

- shiftChange:

    Swaps MASTER and SLAVE properties between upstream and downstream instrument

- isOxcActive:

    Status of optical lock (True: OPTICAL mode, False: RF mode)

- requestedDelay:

    Relative delay to be applied by delay change (Trigger Position)

- delayChange:

    Change delay value by applying (relative) offset

- mPCCLKPhaseP:

    Increment PC master Phase

- mPCCLKPhaseM:

    Decrement PC master Phase

- sPCCLKPhaseP:

    Increment slave PC Phase

- sPCCLKPhaseM:

    Decrement slave PC phase

- savemSWPCCLKPhase:

    Save new software phase value for PCm

- savesSWPCCLKPhase:

    Save new software phase value for PCs

- mBurstStartApply:

    Apply Burst Start Pos

- takemidTsValue:

    Take mid value of phase shifter

- logBoardsStatus:

    JSON string describing master and slave board settings.Usually updated when user actions are taken

- logFineDelay:

    JSON string describing fine delay settings.Usually updated when user actions are taken

- imgprocDevice:

    Device ID of image processor used for feedback

- temDevice:

    id of tem device

- temChannel:

    TEM channel to be controlled

- xCoefWeight:

    weight of X coefficient

- yCoefWeight:

    weight of Y coefficient

- axCoefOld:

    Value of Ax Coefficient saved prior to calibration

- ayCoefOld:

    Value of Ay Coefficient saved prior to calibration

- xBeamCenterTarget:

    desired value for Beam Center X coordinate

- yBeamCenterTarget:

    desired value for Beam Center Y coordinate

- beamCenterMaxDisplacement:

    maximum allowed displacement for Center of Mass from target position

- maxTemDrift:

    Maximum value allowed for TEM drift

- averageNumber:

    number of values of beam center coordinates to average

- timeoutImageProcessorValues:

    Time to wait before going in error when values from image processor are not updating

- imageSettlementTime:

    Time to wait before reading beam center coordinates aftermoving TEM setpoint

- calibrationStep:

    TEM setpoint step size for calibration

- calibrationStepsNumber:

    Number of TEM calibration steps

- maxTimeNotRegulating:

    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

- setCurrentPosAsTarget:

    Set current beam position as target

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

- enableLatchInternal:

    Enables the storage of the value of the scale latched to the internal reference

- enableLatchExternal:

    Enables the storage of the value of the scale latched to the external reference

- adcValue:

    The integer value read out by the encoder

- factor:

    Calibration factor to target unit

- setCounter16:

    Set value for 16 bit encoder.

- setCounter32:

    Set value for 32 bit encoder.

- ssiCoding:

    Binary coding or grey coding. False - Binary; True - Grey

- ssiFrameType:

    Length of the SSI data frame.

- ssiFrameSize:

    Not documented.

- ssiDataLength:

    Not documented.

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

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

###### TRACEYCOMP_FXE_1

Instance id: | LA1_LAS_PPL/ENC/TRACEYCOMP_FXE_1
Host: | exflcon14n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

Device Schema Description

- _serverId_:

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

- _deviceId_:

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

- _connection_:

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

- visibility:

    Configures who is allowed to see this device at all

- deviceId:

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

- classId:

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

- classVersion:

    The version of the class of this device defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- alarmCondition:

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

- lastCommand:

    The last slot called.

- archive:

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

- useTimeserver:

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

- progress:

    The progress of the current action

- heartbeatInterval:

    The heartbeat interval

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

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

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

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

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

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

- epsilon:

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

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

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

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

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

- maxStateUpdateRate:

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

- noisyStateUpdateRateValue:

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

- isStateUpdateNoisy:

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

- reset:

    Resets the PLC hardware

- enableInterlockedSlots:

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

- disableInterlockedSlots:

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

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

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

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

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

- readHardware:

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

- force:

    ???

- trigger:

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

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- value:

    Encoder read value

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

- start:

    Instructs device to go to started state

- stop:

    Instructs device to go to stopped state

- resetADC:

    Reset ADC’s of FPGA in case of constant line, No signal

- resetDDR2:

    Resets DDR2 in case of constant line, No signal

- deviceFile:

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

- mapDirectory:

    Folder where all xml mapping files are located.

- numberRawSamples:

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

- delay:

    Delay between calibration images.

- skipSamples:

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

- triggerTime:

    Time between Triggers

- triggerTimeStat:

    Histogram of time between Triggers

- trainId:

    Current train ID as read from the FPGA

- config:

    Board related configuration parameters.

- dacNode:

    Set up DAC parameters

- channel_0:

    This is a channel of bunch of other parameters

- channel_1:

    This is a channel of bunch of other parameters

- channel_2:

    This is a channel of bunch of other parameters

- channel_3:

    This is a channel of bunch of other parameters

- channel_4:

    This is a channel of bunch of other parameters

- channel_5:

    This is a channel of bunch of other parameters

- channel_6:

    This is a channel of bunch of other parameters

- channel_7:

    This is a channel of bunch of other parameters

- channel_8:

    This is a channel of bunch of other parameters

- channel_9:

    This is a channel of bunch of other parameters

- semiRawValue:

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

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- timeServerId:

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

- Logger:

    Logging settings

- sendCommand:

    Send command to the instrument.

- replyToCommand:

    Reply to the command send to the instrument.

- gotoErrorOnPollFailure:

    Instrument will go to error if poll fails for all properties.

- autoConnect:

    Set True to automatically connect to device.

- pollingInterval:

    The interval for polling the instrument.

- enableHeartbeat:

    Enable Heartbeat

- heartbeatCommand:

    Text to send as heartbeat

- heartbeatReply:

    Heartbeat reply text

- heartbeatPeriod:

    Heartbeat period

- heartbeatTime:

    Last heartbeat time

- pollingTimeTaken:

    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

- pollNow:

    Poll instrument now!

- _connect_:

    Connects to the device

- disconnect:

    Disconnects from the device

- handshake:

    Set the state of the message roundtrip handshaking.

- baudRate:

    Set the transmit and receive baud rates on the RS-232 port.

- errorCount:

    The number of error records in the queue.

- measureType:

    Set the meter measurement mode (energy or power).

- statisticsMode:

    Set the statistics processing mode (on or off).

- variableDecimation:

    Set the pulse decimation rate (1-99999).

- apertureDiameter:

    Set the aperture diameter.

- wavelength:

    Set the current wavelength.

- gainCompensation:

    Enables or disables the gain compensation.

- gainFactor:

    Set the gain compensation factor.

- range:

    Set the measurement range (maximum expected measurement).

- batchSize:

    Set the statistics batch size.

- restartMode:

    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

- statStart:

    Terminates the current statistical batch and start a new one.

- statStop:

    Terminates the current statistical batch.

- triggerSource:

    Selects the trigger source (INTernal / EXTernal).

- triggerLevel:

    Set the trigger level (no effect when external trigger is selected).

- triggerSlope:

    Selects the external trigger edge (POSitive / NEGative).

- sequenceId:

    Set the sequence ID.

- triggerBus:

    Selects the trigger bus participation mode.

- itemSelect:

    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

- statItemSelect:

    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

- serialNumber:

    The serial number string.

- partNumber:

    The part number.

- modelName:

    The Model Name.

- calibrationDate:

    The calibration date.

- manifacturingDate:

    The manifacturing date.

- defaultWavelength:

    The default wavelength.

- measurementRefreshRate:

    The refresh rate of measurements.

- measurement:

    Last measurement.

- idType:

    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

- cameraId:

    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

- packetDelay:

    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

- autoPacketSize:

    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

- packetSize:

    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

- exposureTime:

    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

- triggerMode:

    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

- triggerActivation:

    This enumeration sets the signal transition needed to activate the selected trigger.

- autoGain:

    Configures automatic gain feature.

- gain:

    Sets the gain of the ADC converter.

- acquisitionMode:

    This property sets the image acquisition mode.

- frameCount:

    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

- xPeak1:

    x-position of peak in first calibration image.

- xFWHM1:

    x-FWHM in first calibration image.

- xPeak2:

    x-position of peak in second calibration image.

- xFWHM2:

    x-FWHM in second calibration image.

- delayUnit:

    Unit of the delay between calibration images.

- useAsCalibrationImage1:

    Use the current image as 1st calibration image.

- useAsCalibrationImage2:

    Use the current image as 2nd calibration image.

- calibrate:

  > perform calibrationStepsNumber steps of calibrationStep size starting and ending in symmetrical places relatively to initial position, both along X and Y, while measuring center of beam position.

  > Use these measurements to calculate axCoef and ayCoef.

  > Assumptions that are made: sin(x) ~= x x(y) axis of TEM parallel to x (y) axis of camera

- calibrationFactor:

    The calibration constant.

- beamShape:

    Time shape of the beam.

- xMinFit:

    Lower limit for the fit.

- xMaxFit:

    Upper limit for the fit.

- fitStatus:

    Error of fit procedure: 1-3 means good fit. See device documentation for further details.

- subtractPedestal:

    Subtract the pedestal, calculated from linear interpolation between first and last point.

- xPeak3:

    x-position of peak in the input image.

- xFWHM3:

    x-FWHM in the input image.

- pulseWidth:

    Duration of the pulse.

- ePulseWidth:

    Uncertainty of the pulse duration arising from fit procedure.

- switchToReady:

    Instructs the amplifier to go to ready state.

- switchOn:

    Instructs the amplifier to go to on state.

- switchOff:

    Instructs the amplifier to go to off state.

- closeShutter2:

    Instructs the amplifier to close Shutter 2.

- openShutter2:

    Instructs the amplifier to open Shutter 2.

- amphosIp:

    The IP address of the Amphos Control.

- amphosPort:

    The port of the Amphos Control.

- stateChanging:

    Laser is currently changing state.

- targetPower:

    Target laser power.

- chillerTemperature:

    Measured temperature of chiller.

- chillerFlow:

    Measured flow of chiller [l/min].

- chillerValvePosition:

    Measured valve position.

- shutter2IsOpen:

    Shutter2 State: False=closed True=open

- lambdaIsBusy:

    Lambda plate is moving.

- laserCurrent:

    Measured current of Amphos400.

- laserTemperature:

    Measured temperature of Amphos400.

- laserHumidity:

    Measured humidity of Amphos400.

- xfelCurrentCW1:

    Measured current of XFEL booster 1 (CW1).

- xfelCurrentCW2:

    Measured current of XFEL booster 1 (CW2).

- xfelCurrentQCW1:

    Measured current of XFEL booster 1 (QCW1).

- xfelCurrentQCW2:

    Measured current of XFEL booster 1 (QCW2).

- xfelCurrentQCW3:

    Measured current of XFEL booster 1 (QCW3).

- xfelCurrentQCW4:

    Measured current of XFEL booster 1 (QCW3).

- xfelTemperature:

    Measured temperature of XFEL booster 1.

- xfelHumidity:

    Measured humidity of XFEL booster 1.

- globalAlarmCondition:

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

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- log:

    Logging settings

- adc:

    fast ADC input device

- selectedAdcChannel:

    fast ADC channel in use for the loop

- maxPeakValue:

    Max absolute value for ADC peak. When peak is above this value step is applied

- tuneStage:

    motor controlling the stage to adjust laser path

- stageStep:

    value of stage tuning step size

- loopPeriod:

    Time interval for feedback cycle

- doublecheckWaitTime:

    after peak is above max, this time is waiting to check itagain, before applying step

- calibStepSize:

    Size of calibration step

- calibStepNum:

    Number of calibration steps

- calibAverageNum:

    number of peak values to be averaged for each calibration step

- reverseDirection:

    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

- conversionFactor:

    micrometers to femtoseconds conversion factor

- adcValueTimeout:

    if ADC value is not updated within this time, device goesin error state

- amphosAmpli:

    Karabo ID of Amphos Laser Amplifier

- triggerDelayDevice:

    Karabo ID of pplDelayControl device, used to read Pockels cell status

- moveToPlus:

    Move to +x position

- moveToMinus:

    Move to -x position

- moveToZero:

    Move to 0 position

- pathToProgramFiles:

    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

- correctionFile:

    The correction (.ct5) file, including path.

- useExternalTrigger:

    Use external trigger (if true) or auto-run (if false).

- startFromMinusX:

    Set loop initial position to -X

- jumpSpeed:

    The up/down jump speed [bits/ms].

- jumpAmplitude:

    The up/down jump amplitude [bits].

- delayTimePlus:

    Delay time, after moving to position +x.

- delayTimeMinus:

    Delay time, after moving to position -x.

- onTargetTolerance:

    The tolerance [bits] when checking that Galvo is on target position.

- onTargetPlus:

    Galvo is currently at +x position _and_ not moving.

- onTargetMinus:

    Galvo is currently at -x position _and_ not moving.

- laserOn:

    The value of the LASERON signal.

- digitalOut1:

    The value of the DIGITAL OUT1 signal.

- stopEventCode:

    Stop event code.

- galvoTemperature:

    Galvanometer scanner temperature.

- servoTemperature:

    Servo board temperature.

- agcVoltage:

    AGC voltage (PD supply voltage).

- dspCoreVoltage:

    DSP core supply voltage (1.8 V).

- dspIoVoltage:

    DSP IO voltage (3.3 V).

- analogSectVoltage:

    Analog section voltage (9 V).

- adConverterVoltage:

    AD converter supply voltage (5 V).

- galvoHeatingOut:

    Relative heating output of the corresponding galvanometer scanner heater.

- beamline:

    Beamline where to operate

- timingDevice:

    Device ID of PPL Delay Control Device

- galvoDevice:

    id of Galvo Controller

- downstreamSpectr1Device:

    Spectrometer 1 (FXE/SCS)

- upstreamSpectr1Device:

    Spectrometer 1 (SPB/SQS)

- currentExperiment:

    Current MASTER experiment (UPSTREAM or DOWNSTREAM)

- currentVersion:

    Current version

- correctionFactorMaster:

    Correction Factor Master

- correctionFactorSlave:

    Correction Factor Slave

- switchProgress:

    Switching Progress

- switchExperiment:

    Procedure to automatically swap between FXE and SPB delay control and Galvo settings

- on:

    Instructs the device to switch on

- off:

    Instructs device to switch off

- lastError:

    Last error message received. Time is set by front-end firmware.

- scpiTimeout:

    The SCPI communication timeout.

- baseFreq:

    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

- frontendReset:

    send reset command

- s7ack:

    acknowledge to s7 command

- s8ack:

    acknowledge to s8 command

- s9ack:

    acknowledge to s9 command

- laserEmission:

    True when laser ON, false when OFF

- generalStatus:

    True = OK, False = not OK

- temperatureStatus:

    True = OK, False = not OK

- delayBoardStatus:

    True = OK, False = not OK

- inputPin0Status:

    True = OK, False = not OK

- inputPin4Status:

    True = OK, False = not OK

- pd1Voltage:

    Photodiode 1 (TAB 2) voltage

- pd1VoltageAverage:

    Averaged PD1 (TAB 2) voltage

- pd2Voltage:

    Photodiode 2 (TAB 5) voltage

- pd2VoltageAverage:

    Averaged PD2 (TAB 5) voltage

- pd3Voltage:

    PD3 (SPCO 1) voltage

- pd3VoltageAverage:

    Averaged PD3 (SPCO 1) voltage

- pd4Voltage:

    PD4 (TAB 7) voltage

- pd4VoltageAverage:

    Averaged PD4 (TAB 7) voltage

- pd5Voltage:

    PD5 (SPCO2) voltage

- pd5VoltageAverage:

    Averaged PD5 (SPCO2) voltage

- pd6Voltage:

    PD6 voltage

- pd6VoltageAverage:

    Averaged PD6 voltage

- pd7Voltage:

    PD7 voltage

- pd7VoltageAverage:

    Averaged PD7 voltage

- pd8Voltage:

    PD8 voltage

- pd8VoltageAverage:

    Averaged PD8 voltage

- seederOutPower:

    photodiode 1

- xf1OutPower:

    Photodiode 7

- xf2OutPower:

    Photodiode 8

- seederStatus:

    True = OK, False = not OK

- generalSeederStatus:

    True = OK, False = not OK

- hiltiErrorStatus:

    True = OK, False = not OK

- remoteControl:

    if it is false we cannot see it

- regOnOff0:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- regOnOff1:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- setpAX0:

    Variable SetpAx[0] define the setpoint of the servo loop.

- setpAY0:

    Variable SetpAy[0] define the setpoint of the servo loop.

- sumA0:

    Sum signal of angle detector ‘A’

- sumB0:

    Sum signal of position detector ‘B’

- aX0:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY0:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX0:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY0:

    Variable By represents the measured position deviation in y direction from zero position

- rAX0:

    Regulator Output Ax

- rAY0:

    Regulator Output Ay

- rBX0:

    Regulator Output Bx

- rBY0:

    Regulator Output By

- rAXM0:

    Regulator Output AxM

- rAYM0:

    Regulator Output AyM

- rBXM0:

    Regulator Output BxM

- rBYM0:

    Regulator Output ByM

- setpAX1:

    Variable SetpAx[1] define the setpoint of the servo loop.

- setpAY1:

    Variable SetpAy[1] define the setpoint of the servo loop.

- sumA1:

    Sum signal of angle detector ‘A’

- sumB1:

    Sum signal of position detector ‘B’

- aX1:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY1:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX1:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY1:

    Variable By represents the measured position deviation in y direction from zero position

- rAX1:

    Regulator Output Ax

- rAY1:

    Regulator Output Ay

- rBX1:

    Regulator Output Bx

- rBY1:

    Regulator Output By

- rAXM1:

    Regulator Output AxM

- rAYM1:

    Regulator Output AyM

- rBXM1:

    Regulator Output BxM

- rBYM1:

    Regulator Output ByM

- stage1Id:

    Karabo device ID of first grating motor

- stage2Id:

    Karabo device ID of first grating motor

- tunnel:

    Location where doocs_device is deployed (e.g. ‘SASE1’)

- labx2MName:

    DOOCS name of X2 Master doocs_device

- labx2SName:

    DOOCS name of X2 Slave doocs_device

- timingShifterName:

    DOOCS name of Phase Shifter doocs_device

- manualTuning:

    Manual Tuning Enable

- useShifter:

    Set to True if optical synchronization is available

- midTsValue:

    Mid Value of Phase Shifter

- maxTsDelay:

    Maximum delay to add/subtract to phase shifter position

- maxTsJitter:

    Maximum allowed jitter

- laserOpModeList:

    Select Laser Op Mode

- activeLaserOpMode:

    Active Op laser Mode

- laserOpModeListApply:

    Apply Laser Operation Mode

- dmBCCAuto:

    Automatic loop on/off

- pCellState:

    Status of Pockels Cell, True = On

- pCellOn:

    Set Pockels cell on

- pCellOff:

    Set Pockels cell off

- AOMState:

    Status of AOM, True = On

- AOMOn:

    Set AOM on

- AOMOff:

    Set AOM off

- maxAllowedPcPhase:

    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

- mPCCLKPhase:

    Master PC Phase

- mSWPCCLKPhase:

    Master SW PC Phase

- mBurstWidth:

    Master burst width [us]

- mBurstWidthApply:

    Apply m Burst Width

- mBurstStart:

    Begining of the bursts the slave burst is +50ms)

- mBurstStartsms:

    Master burst starts pos. [us]

- sBurstStartsms:

    Sleve burst starts pos. [us]

- smBurstDiff:

    Different between muster and slave burst positione

- sPCCLKPhase:

    Master PC Phase

- sSWPCCLKPhase:

    Slave software PC PHase

- sBurstWidth:

    Slave burst width [us]

- sBurstWidthApply:

    Apply S Burst width

- delayBPMaster:

    Current delay of the master bunch pattern in clock unit (machine)

- delayBPMasterP:

    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterM:

    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterP24:

    Increment Master Bunch Pattern delay by 24 clock unit

- delayBPMasterM24:

    Decrement Master Bunch Pattern delay by 24 clock unit

- delayBPSlave:

    Current delay of the slave bunch pattern in clock unit (machine)

- delayBPSlaveP:

    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveM:

    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveP24:

    Increment Slave Bunch Pattern delay by 24 clock unit

- delayBPSlaveM24:

    Decrement Slave Bunch Pattern delay by 24 clock unit

- masterExpPattern:

    Select pattern for master experiment

- slaveExpPattern:

    Select pattern for slave experiment

- currentLaserPatterns:

    Current Laser Patterns

- currentMasterLaserPattern:

    Current Master Laser Patterns

- currentSlaveLaserPattern:

    Current Slave Laser Patterns

- currentSlaveLaserPatternN:

    Current Slave Laser Pattern

- fineDelayMaxCounts:

    Fine delay - maximum count number

- fineDelayValue:

    fine delay count value

- fineDelayValueT:

    fine delay time value

- fineDelayP:

    Increment fine delay

- fineDelayM:

    Decrement fine delay

- fineDelay9nsChange:

    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

- fineDelay9ns:

    Change Fine Delay by 9 ns

- minTsPosition:

    Minimum Timing Shifter Delay

- maxTsPosition:

    Maximum Timing Shifter Delay

- currentTsPosition:

    current value of time shifter position

- requestedTsDelay:

    Delay to apply to the phase shifter

- DelayTsChange:

    Change phase shifter by requested value

- relAbsolutTsPos:

    True for relative, False for absolute

- stopPsChange:

    Abort phase shift change

- opticalSynch:

    Display status of optical synchronization

- opticalSynchLock:

    Display lock status of optical synchronization

- opticalSynchJitter:

    Display status of optical synchronization jitter

- opticalSynchMode:

    Optical synch. mode (RF / Optical)

- setOpticalDelay:

    Delay to apply to optical delay line

- applyOpticalDelay:

    change the optical delay by requeste value

- currentOpticalDelay:

    Current position of optical delay

- relAbsolutDelayLine:

    True for relative, False for absolute

- TsJitter:

    Optical Synchronization Jitter

- triggerFE_DOWNSTREAM:

    Current trigger delay FE DOWNSTREAM

- triggerFE_UPSTREAM:

    Current trigger delay FE UPSTREAM

- getCurrentHardwareStatus:

    Read configuration from hardware

- lastShiftDelay:

    FE delay value from the prevoius shift

- setLastShiftDelay:

    Bring the delay to position from the previus shift

- clearLock:

    In case of STATE == changing bring the state to Normal

- mPCCLKPhaseSetValue:

    Master PC CLK Phase Value

- sPCCLKPhaseSetValue:

    Slave PC CLK Phase Value

- delayBPMasterSetValue:

    Master BP delay Value

- delayBPSlaveSetValue:

    Slave BP delay Value

- resetError:

    Reset error state

- upstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for upstream instrument

- downstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for downstream instrument

- shiftChange:

    Swaps MASTER and SLAVE properties between upstream and downstream instrument

- isOxcActive:

    Status of optical lock (True: OPTICAL mode, False: RF mode)

- requestedDelay:

    Relative delay to be applied by delay change (Trigger Position)

- delayChange:

    Change delay value by applying (relative) offset

- mPCCLKPhaseP:

    Increment PC master Phase

- mPCCLKPhaseM:

    Decrement PC master Phase

- sPCCLKPhaseP:

    Increment slave PC Phase

- sPCCLKPhaseM:

    Decrement slave PC phase

- savemSWPCCLKPhase:

    Save new software phase value for PCm

- savesSWPCCLKPhase:

    Save new software phase value for PCs

- mBurstStartApply:

    Apply Burst Start Pos

- takemidTsValue:

    Take mid value of phase shifter

- logBoardsStatus:

    JSON string describing master and slave board settings.Usually updated when user actions are taken

- logFineDelay:

    JSON string describing fine delay settings.Usually updated when user actions are taken

- imgprocDevice:

    Device ID of image processor used for feedback

- temDevice:

    id of tem device

- temChannel:

    TEM channel to be controlled

- xCoefWeight:

    weight of X coefficient

- yCoefWeight:

    weight of Y coefficient

- axCoefOld:

    Value of Ax Coefficient saved prior to calibration

- ayCoefOld:

    Value of Ay Coefficient saved prior to calibration

- xBeamCenterTarget:

    desired value for Beam Center X coordinate

- yBeamCenterTarget:

    desired value for Beam Center Y coordinate

- beamCenterMaxDisplacement:

    maximum allowed displacement for Center of Mass from target position

- maxTemDrift:

    Maximum value allowed for TEM drift

- averageNumber:

    number of values of beam center coordinates to average

- timeoutImageProcessorValues:

    Time to wait before going in error when values from image processor are not updating

- imageSettlementTime:

    Time to wait before reading beam center coordinates aftermoving TEM setpoint

- calibrationStep:

    TEM setpoint step size for calibration

- calibrationStepsNumber:

    Number of TEM calibration steps

- maxTimeNotRegulating:

    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

- setCurrentPosAsTarget:

    Set current beam position as target

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

- enableLatchInternal:

    Enables the storage of the value of the scale latched to the internal reference

- enableLatchExternal:

    Enables the storage of the value of the scale latched to the external reference

- adcValue:

    The integer value read out by the encoder

- factor:

    Calibration factor to target unit

- setCounter16:

    Set value for 16 bit encoder.

- setCounter32:

    Set value for 32 bit encoder.

- ssiCoding:

    Binary coding or grey coding. False - Binary; True - Grey

- ssiFrameType:

    Length of the SSI data frame.

- ssiFrameSize:

    Not documented.

- ssiDataLength:

    Not documented.

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

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

###### TRACEYCOMP_FXE_2

Instance id: | LA1_LAS_PPL/ENC/TRACEYCOMP_FXE_2
Host: | exflcon14n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

Device Schema Description

- _serverId_:

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

- _deviceId_:

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

- _connection_:

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

- visibility:

    Configures who is allowed to see this device at all

- deviceId:

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

- classId:

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

- classVersion:

    The version of the class of this device defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- alarmCondition:

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

- lastCommand:

    The last slot called.

- archive:

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

- useTimeserver:

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

- progress:

    The progress of the current action

- heartbeatInterval:

    The heartbeat interval

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

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

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

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

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

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

- epsilon:

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

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

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

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

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

- maxStateUpdateRate:

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

- noisyStateUpdateRateValue:

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

- isStateUpdateNoisy:

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

- reset:

    Resets the PLC hardware

- enableInterlockedSlots:

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

- disableInterlockedSlots:

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

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

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

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

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

- readHardware:

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

- force:

    ???

- trigger:

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

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- value:

    Encoder read value

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

- start:

    Instructs device to go to started state

- stop:

    Instructs device to go to stopped state

- resetADC:

    Reset ADC’s of FPGA in case of constant line, No signal

- resetDDR2:

    Resets DDR2 in case of constant line, No signal

- deviceFile:

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

- mapDirectory:

    Folder where all xml mapping files are located.

- numberRawSamples:

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

- delay:

    Delay between calibration images.

- skipSamples:

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

- triggerTime:

    Time between Triggers

- triggerTimeStat:

    Histogram of time between Triggers

- trainId:

    Current train ID as read from the FPGA

- config:

    Board related configuration parameters.

- dacNode:

    Set up DAC parameters

- channel_0:

    This is a channel of bunch of other parameters

- channel_1:

    This is a channel of bunch of other parameters

- channel_2:

    This is a channel of bunch of other parameters

- channel_3:

    This is a channel of bunch of other parameters

- channel_4:

    This is a channel of bunch of other parameters

- channel_5:

    This is a channel of bunch of other parameters

- channel_6:

    This is a channel of bunch of other parameters

- channel_7:

    This is a channel of bunch of other parameters

- channel_8:

    This is a channel of bunch of other parameters

- channel_9:

    This is a channel of bunch of other parameters

- semiRawValue:

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

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- timeServerId:

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

- Logger:

    Logging settings

- sendCommand:

    Send command to the instrument.

- replyToCommand:

    Reply to the command send to the instrument.

- gotoErrorOnPollFailure:

    Instrument will go to error if poll fails for all properties.

- autoConnect:

    Set True to automatically connect to device.

- pollingInterval:

    The interval for polling the instrument.

- enableHeartbeat:

    Enable Heartbeat

- heartbeatCommand:

    Text to send as heartbeat

- heartbeatReply:

    Heartbeat reply text

- heartbeatPeriod:

    Heartbeat period

- heartbeatTime:

    Last heartbeat time

- pollingTimeTaken:

    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

- pollNow:

    Poll instrument now!

- _connect_:

    Connects to the device

- disconnect:

    Disconnects from the device

- handshake:

    Set the state of the message roundtrip handshaking.

- baudRate:

    Set the transmit and receive baud rates on the RS-232 port.

- errorCount:

    The number of error records in the queue.

- measureType:

    Set the meter measurement mode (energy or power).

- statisticsMode:

    Set the statistics processing mode (on or off).

- variableDecimation:

    Set the pulse decimation rate (1-99999).

- apertureDiameter:

    Set the aperture diameter.

- wavelength:

    Set the current wavelength.

- gainCompensation:

    Enables or disables the gain compensation.

- gainFactor:

    Set the gain compensation factor.

- range:

    Set the measurement range (maximum expected measurement).

- batchSize:

    Set the statistics batch size.

- restartMode:

    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

- statStart:

    Terminates the current statistical batch and start a new one.

- statStop:

    Terminates the current statistical batch.

- triggerSource:

    Selects the trigger source (INTernal / EXTernal).

- triggerLevel:

    Set the trigger level (no effect when external trigger is selected).

- triggerSlope:

    Selects the external trigger edge (POSitive / NEGative).

- sequenceId:

    Set the sequence ID.

- triggerBus:

    Selects the trigger bus participation mode.

- itemSelect:

    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

- statItemSelect:

    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

- serialNumber:

    The serial number string.

- partNumber:

    The part number.

- modelName:

    The Model Name.

- calibrationDate:

    The calibration date.

- manifacturingDate:

    The manifacturing date.

- defaultWavelength:

    The default wavelength.

- measurementRefreshRate:

    The refresh rate of measurements.

- measurement:

    Last measurement.

- idType:

    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

- cameraId:

    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

- packetDelay:

    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

- autoPacketSize:

    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

- packetSize:

    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

- exposureTime:

    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

- triggerMode:

    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

- triggerActivation:

    This enumeration sets the signal transition needed to activate the selected trigger.

- autoGain:

    Configures automatic gain feature.

- gain:

    Sets the gain of the ADC converter.

- acquisitionMode:

    This property sets the image acquisition mode.

- frameCount:

    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

- xPeak1:

    x-position of peak in first calibration image.

- xFWHM1:

    x-FWHM in first calibration image.

- xPeak2:

    x-position of peak in second calibration image.

- xFWHM2:

    x-FWHM in second calibration image.

- delayUnit:

    Unit of the delay between calibration images.

- useAsCalibrationImage1:

    Use the current image as 1st calibration image.

- useAsCalibrationImage2:

    Use the current image as 2nd calibration image.

- calibrate:

  > perform calibrationStepsNumber steps of calibrationStep size starting and ending in symmetrical places relatively to initial position, both along X and Y, while measuring center of beam position.

  > Use these measurements to calculate axCoef and ayCoef.

  > Assumptions that are made: sin(x) ~= x x(y) axis of TEM parallel to x (y) axis of camera

- calibrationFactor:

    The calibration constant.

- beamShape:

    Time shape of the beam.

- xMinFit:

    Lower limit for the fit.

- xMaxFit:

    Upper limit for the fit.

- fitStatus:

    Error of fit procedure: 1-3 means good fit. See device documentation for further details.

- subtractPedestal:

    Subtract the pedestal, calculated from linear interpolation between first and last point.

- xPeak3:

    x-position of peak in the input image.

- xFWHM3:

    x-FWHM in the input image.

- pulseWidth:

    Duration of the pulse.

- ePulseWidth:

    Uncertainty of the pulse duration arising from fit procedure.

- switchToReady:

    Instructs the amplifier to go to ready state.

- switchOn:

    Instructs the amplifier to go to on state.

- switchOff:

    Instructs the amplifier to go to off state.

- closeShutter2:

    Instructs the amplifier to close Shutter 2.

- openShutter2:

    Instructs the amplifier to open Shutter 2.

- amphosIp:

    The IP address of the Amphos Control.

- amphosPort:

    The port of the Amphos Control.

- stateChanging:

    Laser is currently changing state.

- targetPower:

    Target laser power.

- chillerTemperature:

    Measured temperature of chiller.

- chillerFlow:

    Measured flow of chiller [l/min].

- chillerValvePosition:

    Measured valve position.

- shutter2IsOpen:

    Shutter2 State: False=closed True=open

- lambdaIsBusy:

    Lambda plate is moving.

- laserCurrent:

    Measured current of Amphos400.

- laserTemperature:

    Measured temperature of Amphos400.

- laserHumidity:

    Measured humidity of Amphos400.

- xfelCurrentCW1:

    Measured current of XFEL booster 1 (CW1).

- xfelCurrentCW2:

    Measured current of XFEL booster 1 (CW2).

- xfelCurrentQCW1:

    Measured current of XFEL booster 1 (QCW1).

- xfelCurrentQCW2:

    Measured current of XFEL booster 1 (QCW2).

- xfelCurrentQCW3:

    Measured current of XFEL booster 1 (QCW3).

- xfelCurrentQCW4:

    Measured current of XFEL booster 1 (QCW3).

- xfelTemperature:

    Measured temperature of XFEL booster 1.

- xfelHumidity:

    Measured humidity of XFEL booster 1.

- globalAlarmCondition:

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

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- log:

    Logging settings

- adc:

    fast ADC input device

- selectedAdcChannel:

    fast ADC channel in use for the loop

- maxPeakValue:

    Max absolute value for ADC peak. When peak is above this value step is applied

- tuneStage:

    motor controlling the stage to adjust laser path

- stageStep:

    value of stage tuning step size

- loopPeriod:

    Time interval for feedback cycle

- doublecheckWaitTime:

    after peak is above max, this time is waiting to check itagain, before applying step

- calibStepSize:

    Size of calibration step

- calibStepNum:

    Number of calibration steps

- calibAverageNum:

    number of peak values to be averaged for each calibration step

- reverseDirection:

    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

- conversionFactor:

    micrometers to femtoseconds conversion factor

- adcValueTimeout:

    if ADC value is not updated within this time, device goesin error state

- amphosAmpli:

    Karabo ID of Amphos Laser Amplifier

- triggerDelayDevice:

    Karabo ID of pplDelayControl device, used to read Pockels cell status

- moveToPlus:

    Move to +x position

- moveToMinus:

    Move to -x position

- moveToZero:

    Move to 0 position

- pathToProgramFiles:

    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

- correctionFile:

    The correction (.ct5) file, including path.

- useExternalTrigger:

    Use external trigger (if true) or auto-run (if false).

- startFromMinusX:

    Set loop initial position to -X

- jumpSpeed:

    The up/down jump speed [bits/ms].

- jumpAmplitude:

    The up/down jump amplitude [bits].

- delayTimePlus:

    Delay time, after moving to position +x.

- delayTimeMinus:

    Delay time, after moving to position -x.

- onTargetTolerance:

    The tolerance [bits] when checking that Galvo is on target position.

- onTargetPlus:

    Galvo is currently at +x position _and_ not moving.

- onTargetMinus:

    Galvo is currently at -x position _and_ not moving.

- laserOn:

    The value of the LASERON signal.

- digitalOut1:

    The value of the DIGITAL OUT1 signal.

- stopEventCode:

    Stop event code.

- galvoTemperature:

    Galvanometer scanner temperature.

- servoTemperature:

    Servo board temperature.

- agcVoltage:

    AGC voltage (PD supply voltage).

- dspCoreVoltage:

    DSP core supply voltage (1.8 V).

- dspIoVoltage:

    DSP IO voltage (3.3 V).

- analogSectVoltage:

    Analog section voltage (9 V).

- adConverterVoltage:

    AD converter supply voltage (5 V).

- galvoHeatingOut:

    Relative heating output of the corresponding galvanometer scanner heater.

- beamline:

    Beamline where to operate

- timingDevice:

    Device ID of PPL Delay Control Device

- galvoDevice:

    id of Galvo Controller

- downstreamSpectr1Device:

    Spectrometer 1 (FXE/SCS)

- upstreamSpectr1Device:

    Spectrometer 1 (SPB/SQS)

- currentExperiment:

    Current MASTER experiment (UPSTREAM or DOWNSTREAM)

- currentVersion:

    Current version

- correctionFactorMaster:

    Correction Factor Master

- correctionFactorSlave:

    Correction Factor Slave

- switchProgress:

    Switching Progress

- switchExperiment:

    Procedure to automatically swap between FXE and SPB delay control and Galvo settings

- on:

    Instructs the device to switch on

- off:

    Instructs device to switch off

- lastError:

    Last error message received. Time is set by front-end firmware.

- scpiTimeout:

    The SCPI communication timeout.

- baseFreq:

    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

- frontendReset:

    send reset command

- s7ack:

    acknowledge to s7 command

- s8ack:

    acknowledge to s8 command

- s9ack:

    acknowledge to s9 command

- laserEmission:

    True when laser ON, false when OFF

- generalStatus:

    True = OK, False = not OK

- temperatureStatus:

    True = OK, False = not OK

- delayBoardStatus:

    True = OK, False = not OK

- inputPin0Status:

    True = OK, False = not OK

- inputPin4Status:

    True = OK, False = not OK

- pd1Voltage:

    Photodiode 1 (TAB 2) voltage

- pd1VoltageAverage:

    Averaged PD1 (TAB 2) voltage

- pd2Voltage:

    Photodiode 2 (TAB 5) voltage

- pd2VoltageAverage:

    Averaged PD2 (TAB 5) voltage

- pd3Voltage:

    PD3 (SPCO 1) voltage

- pd3VoltageAverage:

    Averaged PD3 (SPCO 1) voltage

- pd4Voltage:

    PD4 (TAB 7) voltage

- pd4VoltageAverage:

    Averaged PD4 (TAB 7) voltage

- pd5Voltage:

    PD5 (SPCO2) voltage

- pd5VoltageAverage:

    Averaged PD5 (SPCO2) voltage

- pd6Voltage:

    PD6 voltage

- pd6VoltageAverage:

    Averaged PD6 voltage

- pd7Voltage:

    PD7 voltage

- pd7VoltageAverage:

    Averaged PD7 voltage

- pd8Voltage:

    PD8 voltage

- pd8VoltageAverage:

    Averaged PD8 voltage

- seederOutPower:

    photodiode 1

- xf1OutPower:

    Photodiode 7

- xf2OutPower:

    Photodiode 8

- seederStatus:

    True = OK, False = not OK

- generalSeederStatus:

    True = OK, False = not OK

- hiltiErrorStatus:

    True = OK, False = not OK

- remoteControl:

    if it is false we cannot see it

- regOnOff0:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- regOnOff1:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- setpAX0:

    Variable SetpAx[0] define the setpoint of the servo loop.

- setpAY0:

    Variable SetpAy[0] define the setpoint of the servo loop.

- sumA0:

    Sum signal of angle detector ‘A’

- sumB0:

    Sum signal of position detector ‘B’

- aX0:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY0:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX0:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY0:

    Variable By represents the measured position deviation in y direction from zero position

- rAX0:

    Regulator Output Ax

- rAY0:

    Regulator Output Ay

- rBX0:

    Regulator Output Bx

- rBY0:

    Regulator Output By

- rAXM0:

    Regulator Output AxM

- rAYM0:

    Regulator Output AyM

- rBXM0:

    Regulator Output BxM

- rBYM0:

    Regulator Output ByM

- setpAX1:

    Variable SetpAx[1] define the setpoint of the servo loop.

- setpAY1:

    Variable SetpAy[1] define the setpoint of the servo loop.

- sumA1:

    Sum signal of angle detector ‘A’

- sumB1:

    Sum signal of position detector ‘B’

- aX1:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY1:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX1:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY1:

    Variable By represents the measured position deviation in y direction from zero position

- rAX1:

    Regulator Output Ax

- rAY1:

    Regulator Output Ay

- rBX1:

    Regulator Output Bx

- rBY1:

    Regulator Output By

- rAXM1:

    Regulator Output AxM

- rAYM1:

    Regulator Output AyM

- rBXM1:

    Regulator Output BxM

- rBYM1:

    Regulator Output ByM

- stage1Id:

    Karabo device ID of first grating motor

- stage2Id:

    Karabo device ID of first grating motor

- tunnel:

    Location where doocs_device is deployed (e.g. ‘SASE1’)

- labx2MName:

    DOOCS name of X2 Master doocs_device

- labx2SName:

    DOOCS name of X2 Slave doocs_device

- timingShifterName:

    DOOCS name of Phase Shifter doocs_device

- manualTuning:

    Manual Tuning Enable

- useShifter:

    Set to True if optical synchronization is available

- midTsValue:

    Mid Value of Phase Shifter

- maxTsDelay:

    Maximum delay to add/subtract to phase shifter position

- maxTsJitter:

    Maximum allowed jitter

- laserOpModeList:

    Select Laser Op Mode

- activeLaserOpMode:

    Active Op laser Mode

- laserOpModeListApply:

    Apply Laser Operation Mode

- dmBCCAuto:

    Automatic loop on/off

- pCellState:

    Status of Pockels Cell, True = On

- pCellOn:

    Set Pockels cell on

- pCellOff:

    Set Pockels cell off

- AOMState:

    Status of AOM, True = On

- AOMOn:

    Set AOM on

- AOMOff:

    Set AOM off

- maxAllowedPcPhase:

    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

- mPCCLKPhase:

    Master PC Phase

- mSWPCCLKPhase:

    Master SW PC Phase

- mBurstWidth:

    Master burst width [us]

- mBurstWidthApply:

    Apply m Burst Width

- mBurstStart:

    Begining of the bursts the slave burst is +50ms)

- mBurstStartsms:

    Master burst starts pos. [us]

- sBurstStartsms:

    Sleve burst starts pos. [us]

- smBurstDiff:

    Different between muster and slave burst positione

- sPCCLKPhase:

    Master PC Phase

- sSWPCCLKPhase:

    Slave software PC PHase

- sBurstWidth:

    Slave burst width [us]

- sBurstWidthApply:

    Apply S Burst width

- delayBPMaster:

    Current delay of the master bunch pattern in clock unit (machine)

- delayBPMasterP:

    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterM:

    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterP24:

    Increment Master Bunch Pattern delay by 24 clock unit

- delayBPMasterM24:

    Decrement Master Bunch Pattern delay by 24 clock unit

- delayBPSlave:

    Current delay of the slave bunch pattern in clock unit (machine)

- delayBPSlaveP:

    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveM:

    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveP24:

    Increment Slave Bunch Pattern delay by 24 clock unit

- delayBPSlaveM24:

    Decrement Slave Bunch Pattern delay by 24 clock unit

- masterExpPattern:

    Select pattern for master experiment

- slaveExpPattern:

    Select pattern for slave experiment

- currentLaserPatterns:

    Current Laser Patterns

- currentMasterLaserPattern:

    Current Master Laser Patterns

- currentSlaveLaserPattern:

    Current Slave Laser Patterns

- currentSlaveLaserPatternN:

    Current Slave Laser Pattern

- fineDelayMaxCounts:

    Fine delay - maximum count number

- fineDelayValue:

    fine delay count value

- fineDelayValueT:

    fine delay time value

- fineDelayP:

    Increment fine delay

- fineDelayM:

    Decrement fine delay

- fineDelay9nsChange:

    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

- fineDelay9ns:

    Change Fine Delay by 9 ns

- minTsPosition:

    Minimum Timing Shifter Delay

- maxTsPosition:

    Maximum Timing Shifter Delay

- currentTsPosition:

    current value of time shifter position

- requestedTsDelay:

    Delay to apply to the phase shifter

- DelayTsChange:

    Change phase shifter by requested value

- relAbsolutTsPos:

    True for relative, False for absolute

- stopPsChange:

    Abort phase shift change

- opticalSynch:

    Display status of optical synchronization

- opticalSynchLock:

    Display lock status of optical synchronization

- opticalSynchJitter:

    Display status of optical synchronization jitter

- opticalSynchMode:

    Optical synch. mode (RF / Optical)

- setOpticalDelay:

    Delay to apply to optical delay line

- applyOpticalDelay:

    change the optical delay by requeste value

- currentOpticalDelay:

    Current position of optical delay

- relAbsolutDelayLine:

    True for relative, False for absolute

- TsJitter:

    Optical Synchronization Jitter

- triggerFE_DOWNSTREAM:

    Current trigger delay FE DOWNSTREAM

- triggerFE_UPSTREAM:

    Current trigger delay FE UPSTREAM

- getCurrentHardwareStatus:

    Read configuration from hardware

- lastShiftDelay:

    FE delay value from the prevoius shift

- setLastShiftDelay:

    Bring the delay to position from the previus shift

- clearLock:

    In case of STATE == changing bring the state to Normal

- mPCCLKPhaseSetValue:

    Master PC CLK Phase Value

- sPCCLKPhaseSetValue:

    Slave PC CLK Phase Value

- delayBPMasterSetValue:

    Master BP delay Value

- delayBPSlaveSetValue:

    Slave BP delay Value

- resetError:

    Reset error state

- upstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for upstream instrument

- downstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for downstream instrument

- shiftChange:

    Swaps MASTER and SLAVE properties between upstream and downstream instrument

- isOxcActive:

    Status of optical lock (True: OPTICAL mode, False: RF mode)

- requestedDelay:

    Relative delay to be applied by delay change (Trigger Position)

- delayChange:

    Change delay value by applying (relative) offset

- mPCCLKPhaseP:

    Increment PC master Phase

- mPCCLKPhaseM:

    Decrement PC master Phase

- sPCCLKPhaseP:

    Increment slave PC Phase

- sPCCLKPhaseM:

    Decrement slave PC phase

- savemSWPCCLKPhase:

    Save new software phase value for PCm

- savesSWPCCLKPhase:

    Save new software phase value for PCs

- mBurstStartApply:

    Apply Burst Start Pos

- takemidTsValue:

    Take mid value of phase shifter

- logBoardsStatus:

    JSON string describing master and slave board settings.Usually updated when user actions are taken

- logFineDelay:

    JSON string describing fine delay settings.Usually updated when user actions are taken

- imgprocDevice:

    Device ID of image processor used for feedback

- temDevice:

    id of tem device

- temChannel:

    TEM channel to be controlled

- xCoefWeight:

    weight of X coefficient

- yCoefWeight:

    weight of Y coefficient

- axCoefOld:

    Value of Ax Coefficient saved prior to calibration

- ayCoefOld:

    Value of Ay Coefficient saved prior to calibration

- xBeamCenterTarget:

    desired value for Beam Center X coordinate

- yBeamCenterTarget:

    desired value for Beam Center Y coordinate

- beamCenterMaxDisplacement:

    maximum allowed displacement for Center of Mass from target position

- maxTemDrift:

    Maximum value allowed for TEM drift

- averageNumber:

    number of values of beam center coordinates to average

- timeoutImageProcessorValues:

    Time to wait before going in error when values from image processor are not updating

- imageSettlementTime:

    Time to wait before reading beam center coordinates aftermoving TEM setpoint

- calibrationStep:

    TEM setpoint step size for calibration

- calibrationStepsNumber:

    Number of TEM calibration steps

- maxTimeNotRegulating:

    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

- setCurrentPosAsTarget:

    Set current beam position as target

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

- enableLatchInternal:

    Enables the storage of the value of the scale latched to the internal reference

- enableLatchExternal:

    Enables the storage of the value of the scale latched to the external reference

- adcValue:

    The integer value read out by the encoder

- factor:

    Calibration factor to target unit

- setCounter16:

    Set value for 16 bit encoder.

- setCounter32:

    Set value for 32 bit encoder.

- ssiCoding:

    Binary coding or grey coding. False - Binary; True - Grey

- ssiFrameType:

    Length of the SSI data frame.

- ssiFrameSize:

    Not documented.

- ssiDataLength:

    Not documented.

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

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

###### TRACEYCOMP_SPB_1

Instance id: | LA1_LAS_PPL/ENC/TRACEYCOMP_SPB_1
Host: | exflcon14n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

Device Schema Description

- _serverId_:

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

- _deviceId_:

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

- _connection_:

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

- visibility:

    Configures who is allowed to see this device at all

- deviceId:

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

- classId:

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

- classVersion:

    The version of the class of this device defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- alarmCondition:

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

- lastCommand:

    The last slot called.

- archive:

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

- useTimeserver:

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

- progress:

    The progress of the current action

- heartbeatInterval:

    The heartbeat interval

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

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

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

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

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

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

- epsilon:

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

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

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

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

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

- maxStateUpdateRate:

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

- noisyStateUpdateRateValue:

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

- isStateUpdateNoisy:

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

- reset:

    Resets the PLC hardware

- enableInterlockedSlots:

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

- disableInterlockedSlots:

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

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

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

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

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

- readHardware:

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

- force:

    ???

- trigger:

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

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- value:

    Encoder read value

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

- start:

    Instructs device to go to started state

- stop:

    Instructs device to go to stopped state

- resetADC:

    Reset ADC’s of FPGA in case of constant line, No signal

- resetDDR2:

    Resets DDR2 in case of constant line, No signal

- deviceFile:

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

- mapDirectory:

    Folder where all xml mapping files are located.

- numberRawSamples:

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

- delay:

    Delay between calibration images.

- skipSamples:

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

- triggerTime:

    Time between Triggers

- triggerTimeStat:

    Histogram of time between Triggers

- trainId:

    Current train ID as read from the FPGA

- config:

    Board related configuration parameters.

- dacNode:

    Set up DAC parameters

- channel_0:

    This is a channel of bunch of other parameters

- channel_1:

    This is a channel of bunch of other parameters

- channel_2:

    This is a channel of bunch of other parameters

- channel_3:

    This is a channel of bunch of other parameters

- channel_4:

    This is a channel of bunch of other parameters

- channel_5:

    This is a channel of bunch of other parameters

- channel_6:

    This is a channel of bunch of other parameters

- channel_7:

    This is a channel of bunch of other parameters

- channel_8:

    This is a channel of bunch of other parameters

- channel_9:

    This is a channel of bunch of other parameters

- semiRawValue:

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

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- timeServerId:

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

- Logger:

    Logging settings

- sendCommand:

    Send command to the instrument.

- replyToCommand:

    Reply to the command send to the instrument.

- gotoErrorOnPollFailure:

    Instrument will go to error if poll fails for all properties.

- autoConnect:

    Set True to automatically connect to device.

- pollingInterval:

    The interval for polling the instrument.

- enableHeartbeat:

    Enable Heartbeat

- heartbeatCommand:

    Text to send as heartbeat

- heartbeatReply:

    Heartbeat reply text

- heartbeatPeriod:

    Heartbeat period

- heartbeatTime:

    Last heartbeat time

- pollingTimeTaken:

    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

- pollNow:

    Poll instrument now!

- _connect_:

    Connects to the device

- disconnect:

    Disconnects from the device

- handshake:

    Set the state of the message roundtrip handshaking.

- baudRate:

    Set the transmit and receive baud rates on the RS-232 port.

- errorCount:

    The number of error records in the queue.

- measureType:

    Set the meter measurement mode (energy or power).

- statisticsMode:

    Set the statistics processing mode (on or off).

- variableDecimation:

    Set the pulse decimation rate (1-99999).

- apertureDiameter:

    Set the aperture diameter.

- wavelength:

    Set the current wavelength.

- gainCompensation:

    Enables or disables the gain compensation.

- gainFactor:

    Set the gain compensation factor.

- range:

    Set the measurement range (maximum expected measurement).

- batchSize:

    Set the statistics batch size.

- restartMode:

    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

- statStart:

    Terminates the current statistical batch and start a new one.

- statStop:

    Terminates the current statistical batch.

- triggerSource:

    Selects the trigger source (INTernal / EXTernal).

- triggerLevel:

    Set the trigger level (no effect when external trigger is selected).

- triggerSlope:

    Selects the external trigger edge (POSitive / NEGative).

- sequenceId:

    Set the sequence ID.

- triggerBus:

    Selects the trigger bus participation mode.

- itemSelect:

    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

- statItemSelect:

    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

- serialNumber:

    The serial number string.

- partNumber:

    The part number.

- modelName:

    The Model Name.

- calibrationDate:

    The calibration date.

- manifacturingDate:

    The manifacturing date.

- defaultWavelength:

    The default wavelength.

- measurementRefreshRate:

    The refresh rate of measurements.

- measurement:

    Last measurement.

- idType:

    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

- cameraId:

    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

- packetDelay:

    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

- autoPacketSize:

    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

- packetSize:

    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

- exposureTime:

    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

- triggerMode:

    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

- triggerActivation:

    This enumeration sets the signal transition needed to activate the selected trigger.

- autoGain:

    Configures automatic gain feature.

- gain:

    Sets the gain of the ADC converter.

- acquisitionMode:

    This property sets the image acquisition mode.

- frameCount:

    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

- xPeak1:

    x-position of peak in first calibration image.

- xFWHM1:

    x-FWHM in first calibration image.

- xPeak2:

    x-position of peak in second calibration image.

- xFWHM2:

    x-FWHM in second calibration image.

- delayUnit:

    Unit of the delay between calibration images.

- useAsCalibrationImage1:

    Use the current image as 1st calibration image.

- useAsCalibrationImage2:

    Use the current image as 2nd calibration image.

- calibrate:

  > perform calibrationStepsNumber steps of calibrationStep size starting and ending in symmetrical places relatively to initial position, both along X and Y, while measuring center of beam position.

  > Use these measurements to calculate axCoef and ayCoef.

  > Assumptions that are made: sin(x) ~= x x(y) axis of TEM parallel to x (y) axis of camera

- calibrationFactor:

    The calibration constant.

- beamShape:

    Time shape of the beam.

- xMinFit:

    Lower limit for the fit.

- xMaxFit:

    Upper limit for the fit.

- fitStatus:

    Error of fit procedure: 1-3 means good fit. See device documentation for further details.

- subtractPedestal:

    Subtract the pedestal, calculated from linear interpolation between first and last point.

- xPeak3:

    x-position of peak in the input image.

- xFWHM3:

    x-FWHM in the input image.

- pulseWidth:

    Duration of the pulse.

- ePulseWidth:

    Uncertainty of the pulse duration arising from fit procedure.

- switchToReady:

    Instructs the amplifier to go to ready state.

- switchOn:

    Instructs the amplifier to go to on state.

- switchOff:

    Instructs the amplifier to go to off state.

- closeShutter2:

    Instructs the amplifier to close Shutter 2.

- openShutter2:

    Instructs the amplifier to open Shutter 2.

- amphosIp:

    The IP address of the Amphos Control.

- amphosPort:

    The port of the Amphos Control.

- stateChanging:

    Laser is currently changing state.

- targetPower:

    Target laser power.

- chillerTemperature:

    Measured temperature of chiller.

- chillerFlow:

    Measured flow of chiller [l/min].

- chillerValvePosition:

    Measured valve position.

- shutter2IsOpen:

    Shutter2 State: False=closed True=open

- lambdaIsBusy:

    Lambda plate is moving.

- laserCurrent:

    Measured current of Amphos400.

- laserTemperature:

    Measured temperature of Amphos400.

- laserHumidity:

    Measured humidity of Amphos400.

- xfelCurrentCW1:

    Measured current of XFEL booster 1 (CW1).

- xfelCurrentCW2:

    Measured current of XFEL booster 1 (CW2).

- xfelCurrentQCW1:

    Measured current of XFEL booster 1 (QCW1).

- xfelCurrentQCW2:

    Measured current of XFEL booster 1 (QCW2).

- xfelCurrentQCW3:

    Measured current of XFEL booster 1 (QCW3).

- xfelCurrentQCW4:

    Measured current of XFEL booster 1 (QCW3).

- xfelTemperature:

    Measured temperature of XFEL booster 1.

- xfelHumidity:

    Measured humidity of XFEL booster 1.

- globalAlarmCondition:

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

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- log:

    Logging settings

- adc:

    fast ADC input device

- selectedAdcChannel:

    fast ADC channel in use for the loop

- maxPeakValue:

    Max absolute value for ADC peak. When peak is above this value step is applied

- tuneStage:

    motor controlling the stage to adjust laser path

- stageStep:

    value of stage tuning step size

- loopPeriod:

    Time interval for feedback cycle

- doublecheckWaitTime:

    after peak is above max, this time is waiting to check itagain, before applying step

- calibStepSize:

    Size of calibration step

- calibStepNum:

    Number of calibration steps

- calibAverageNum:

    number of peak values to be averaged for each calibration step

- reverseDirection:

    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

- conversionFactor:

    micrometers to femtoseconds conversion factor

- adcValueTimeout:

    if ADC value is not updated within this time, device goesin error state

- amphosAmpli:

    Karabo ID of Amphos Laser Amplifier

- triggerDelayDevice:

    Karabo ID of pplDelayControl device, used to read Pockels cell status

- moveToPlus:

    Move to +x position

- moveToMinus:

    Move to -x position

- moveToZero:

    Move to 0 position

- pathToProgramFiles:

    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

- correctionFile:

    The correction (.ct5) file, including path.

- useExternalTrigger:

    Use external trigger (if true) or auto-run (if false).

- startFromMinusX:

    Set loop initial position to -X

- jumpSpeed:

    The up/down jump speed [bits/ms].

- jumpAmplitude:

    The up/down jump amplitude [bits].

- delayTimePlus:

    Delay time, after moving to position +x.

- delayTimeMinus:

    Delay time, after moving to position -x.

- onTargetTolerance:

    The tolerance [bits] when checking that Galvo is on target position.

- onTargetPlus:

    Galvo is currently at +x position _and_ not moving.

- onTargetMinus:

    Galvo is currently at -x position _and_ not moving.

- laserOn:

    The value of the LASERON signal.

- digitalOut1:

    The value of the DIGITAL OUT1 signal.

- stopEventCode:

    Stop event code.

- galvoTemperature:

    Galvanometer scanner temperature.

- servoTemperature:

    Servo board temperature.

- agcVoltage:

    AGC voltage (PD supply voltage).

- dspCoreVoltage:

    DSP core supply voltage (1.8 V).

- dspIoVoltage:

    DSP IO voltage (3.3 V).

- analogSectVoltage:

    Analog section voltage (9 V).

- adConverterVoltage:

    AD converter supply voltage (5 V).

- galvoHeatingOut:

    Relative heating output of the corresponding galvanometer scanner heater.

- beamline:

    Beamline where to operate

- timingDevice:

    Device ID of PPL Delay Control Device

- galvoDevice:

    id of Galvo Controller

- downstreamSpectr1Device:

    Spectrometer 1 (FXE/SCS)

- upstreamSpectr1Device:

    Spectrometer 1 (SPB/SQS)

- currentExperiment:

    Current MASTER experiment (UPSTREAM or DOWNSTREAM)

- currentVersion:

    Current version

- correctionFactorMaster:

    Correction Factor Master

- correctionFactorSlave:

    Correction Factor Slave

- switchProgress:

    Switching Progress

- switchExperiment:

    Procedure to automatically swap between FXE and SPB delay control and Galvo settings

- on:

    Instructs the device to switch on

- off:

    Instructs device to switch off

- lastError:

    Last error message received. Time is set by front-end firmware.

- scpiTimeout:

    The SCPI communication timeout.

- baseFreq:

    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

- frontendReset:

    send reset command

- s7ack:

    acknowledge to s7 command

- s8ack:

    acknowledge to s8 command

- s9ack:

    acknowledge to s9 command

- laserEmission:

    True when laser ON, false when OFF

- generalStatus:

    True = OK, False = not OK

- temperatureStatus:

    True = OK, False = not OK

- delayBoardStatus:

    True = OK, False = not OK

- inputPin0Status:

    True = OK, False = not OK

- inputPin4Status:

    True = OK, False = not OK

- pd1Voltage:

    Photodiode 1 (TAB 2) voltage

- pd1VoltageAverage:

    Averaged PD1 (TAB 2) voltage

- pd2Voltage:

    Photodiode 2 (TAB 5) voltage

- pd2VoltageAverage:

    Averaged PD2 (TAB 5) voltage

- pd3Voltage:

    PD3 (SPCO 1) voltage

- pd3VoltageAverage:

    Averaged PD3 (SPCO 1) voltage

- pd4Voltage:

    PD4 (TAB 7) voltage

- pd4VoltageAverage:

    Averaged PD4 (TAB 7) voltage

- pd5Voltage:

    PD5 (SPCO2) voltage

- pd5VoltageAverage:

    Averaged PD5 (SPCO2) voltage

- pd6Voltage:

    PD6 voltage

- pd6VoltageAverage:

    Averaged PD6 voltage

- pd7Voltage:

    PD7 voltage

- pd7VoltageAverage:

    Averaged PD7 voltage

- pd8Voltage:

    PD8 voltage

- pd8VoltageAverage:

    Averaged PD8 voltage

- seederOutPower:

    photodiode 1

- xf1OutPower:

    Photodiode 7

- xf2OutPower:

    Photodiode 8

- seederStatus:

    True = OK, False = not OK

- generalSeederStatus:

    True = OK, False = not OK

- hiltiErrorStatus:

    True = OK, False = not OK

- remoteControl:

    if it is false we cannot see it

- regOnOff0:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- regOnOff1:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- setpAX0:

    Variable SetpAx[0] define the setpoint of the servo loop.

- setpAY0:

    Variable SetpAy[0] define the setpoint of the servo loop.

- sumA0:

    Sum signal of angle detector ‘A’

- sumB0:

    Sum signal of position detector ‘B’

- aX0:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY0:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX0:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY0:

    Variable By represents the measured position deviation in y direction from zero position

- rAX0:

    Regulator Output Ax

- rAY0:

    Regulator Output Ay

- rBX0:

    Regulator Output Bx

- rBY0:

    Regulator Output By

- rAXM0:

    Regulator Output AxM

- rAYM0:

    Regulator Output AyM

- rBXM0:

    Regulator Output BxM

- rBYM0:

    Regulator Output ByM

- setpAX1:

    Variable SetpAx[1] define the setpoint of the servo loop.

- setpAY1:

    Variable SetpAy[1] define the setpoint of the servo loop.

- sumA1:

    Sum signal of angle detector ‘A’

- sumB1:

    Sum signal of position detector ‘B’

- aX1:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY1:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX1:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY1:

    Variable By represents the measured position deviation in y direction from zero position

- rAX1:

    Regulator Output Ax

- rAY1:

    Regulator Output Ay

- rBX1:

    Regulator Output Bx

- rBY1:

    Regulator Output By

- rAXM1:

    Regulator Output AxM

- rAYM1:

    Regulator Output AyM

- rBXM1:

    Regulator Output BxM

- rBYM1:

    Regulator Output ByM

- stage1Id:

    Karabo device ID of first grating motor

- stage2Id:

    Karabo device ID of first grating motor

- tunnel:

    Location where doocs_device is deployed (e.g. ‘SASE1’)

- labx2MName:

    DOOCS name of X2 Master doocs_device

- labx2SName:

    DOOCS name of X2 Slave doocs_device

- timingShifterName:

    DOOCS name of Phase Shifter doocs_device

- manualTuning:

    Manual Tuning Enable

- useShifter:

    Set to True if optical synchronization is available

- midTsValue:

    Mid Value of Phase Shifter

- maxTsDelay:

    Maximum delay to add/subtract to phase shifter position

- maxTsJitter:

    Maximum allowed jitter

- laserOpModeList:

    Select Laser Op Mode

- activeLaserOpMode:

    Active Op laser Mode

- laserOpModeListApply:

    Apply Laser Operation Mode

- dmBCCAuto:

    Automatic loop on/off

- pCellState:

    Status of Pockels Cell, True = On

- pCellOn:

    Set Pockels cell on

- pCellOff:

    Set Pockels cell off

- AOMState:

    Status of AOM, True = On

- AOMOn:

    Set AOM on

- AOMOff:

    Set AOM off

- maxAllowedPcPhase:

    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

- mPCCLKPhase:

    Master PC Phase

- mSWPCCLKPhase:

    Master SW PC Phase

- mBurstWidth:

    Master burst width [us]

- mBurstWidthApply:

    Apply m Burst Width

- mBurstStart:

    Begining of the bursts the slave burst is +50ms)

- mBurstStartsms:

    Master burst starts pos. [us]

- sBurstStartsms:

    Sleve burst starts pos. [us]

- smBurstDiff:

    Different between muster and slave burst positione

- sPCCLKPhase:

    Master PC Phase

- sSWPCCLKPhase:

    Slave software PC PHase

- sBurstWidth:

    Slave burst width [us]

- sBurstWidthApply:

    Apply S Burst width

- delayBPMaster:

    Current delay of the master bunch pattern in clock unit (machine)

- delayBPMasterP:

    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterM:

    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterP24:

    Increment Master Bunch Pattern delay by 24 clock unit

- delayBPMasterM24:

    Decrement Master Bunch Pattern delay by 24 clock unit

- delayBPSlave:

    Current delay of the slave bunch pattern in clock unit (machine)

- delayBPSlaveP:

    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveM:

    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveP24:

    Increment Slave Bunch Pattern delay by 24 clock unit

- delayBPSlaveM24:

    Decrement Slave Bunch Pattern delay by 24 clock unit

- masterExpPattern:

    Select pattern for master experiment

- slaveExpPattern:

    Select pattern for slave experiment

- currentLaserPatterns:

    Current Laser Patterns

- currentMasterLaserPattern:

    Current Master Laser Patterns

- currentSlaveLaserPattern:

    Current Slave Laser Patterns

- currentSlaveLaserPatternN:

    Current Slave Laser Pattern

- fineDelayMaxCounts:

    Fine delay - maximum count number

- fineDelayValue:

    fine delay count value

- fineDelayValueT:

    fine delay time value

- fineDelayP:

    Increment fine delay

- fineDelayM:

    Decrement fine delay

- fineDelay9nsChange:

    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

- fineDelay9ns:

    Change Fine Delay by 9 ns

- minTsPosition:

    Minimum Timing Shifter Delay

- maxTsPosition:

    Maximum Timing Shifter Delay

- currentTsPosition:

    current value of time shifter position

- requestedTsDelay:

    Delay to apply to the phase shifter

- DelayTsChange:

    Change phase shifter by requested value

- relAbsolutTsPos:

    True for relative, False for absolute

- stopPsChange:

    Abort phase shift change

- opticalSynch:

    Display status of optical synchronization

- opticalSynchLock:

    Display lock status of optical synchronization

- opticalSynchJitter:

    Display status of optical synchronization jitter

- opticalSynchMode:

    Optical synch. mode (RF / Optical)

- setOpticalDelay:

    Delay to apply to optical delay line

- applyOpticalDelay:

    change the optical delay by requeste value

- currentOpticalDelay:

    Current position of optical delay

- relAbsolutDelayLine:

    True for relative, False for absolute

- TsJitter:

    Optical Synchronization Jitter

- triggerFE_DOWNSTREAM:

    Current trigger delay FE DOWNSTREAM

- triggerFE_UPSTREAM:

    Current trigger delay FE UPSTREAM

- getCurrentHardwareStatus:

    Read configuration from hardware

- lastShiftDelay:

    FE delay value from the prevoius shift

- setLastShiftDelay:

    Bring the delay to position from the previus shift

- clearLock:

    In case of STATE == changing bring the state to Normal

- mPCCLKPhaseSetValue:

    Master PC CLK Phase Value

- sPCCLKPhaseSetValue:

    Slave PC CLK Phase Value

- delayBPMasterSetValue:

    Master BP delay Value

- delayBPSlaveSetValue:

    Slave BP delay Value

- resetError:

    Reset error state

- upstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for upstream instrument

- downstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for downstream instrument

- shiftChange:

    Swaps MASTER and SLAVE properties between upstream and downstream instrument

- isOxcActive:

    Status of optical lock (True: OPTICAL mode, False: RF mode)

- requestedDelay:

    Relative delay to be applied by delay change (Trigger Position)

- delayChange:

    Change delay value by applying (relative) offset

- mPCCLKPhaseP:

    Increment PC master Phase

- mPCCLKPhaseM:

    Decrement PC master Phase

- sPCCLKPhaseP:

    Increment slave PC Phase

- sPCCLKPhaseM:

    Decrement slave PC phase

- savemSWPCCLKPhase:

    Save new software phase value for PCm

- savesSWPCCLKPhase:

    Save new software phase value for PCs

- mBurstStartApply:

    Apply Burst Start Pos

- takemidTsValue:

    Take mid value of phase shifter

- logBoardsStatus:

    JSON string describing master and slave board settings.Usually updated when user actions are taken

- logFineDelay:

    JSON string describing fine delay settings.Usually updated when user actions are taken

- imgprocDevice:

    Device ID of image processor used for feedback

- temDevice:

    id of tem device

- temChannel:

    TEM channel to be controlled

- xCoefWeight:

    weight of X coefficient

- yCoefWeight:

    weight of Y coefficient

- axCoefOld:

    Value of Ax Coefficient saved prior to calibration

- ayCoefOld:

    Value of Ay Coefficient saved prior to calibration

- xBeamCenterTarget:

    desired value for Beam Center X coordinate

- yBeamCenterTarget:

    desired value for Beam Center Y coordinate

- beamCenterMaxDisplacement:

    maximum allowed displacement for Center of Mass from target position

- maxTemDrift:

    Maximum value allowed for TEM drift

- averageNumber:

    number of values of beam center coordinates to average

- timeoutImageProcessorValues:

    Time to wait before going in error when values from image processor are not updating

- imageSettlementTime:

    Time to wait before reading beam center coordinates aftermoving TEM setpoint

- calibrationStep:

    TEM setpoint step size for calibration

- calibrationStepsNumber:

    Number of TEM calibration steps

- maxTimeNotRegulating:

    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

- setCurrentPosAsTarget:

    Set current beam position as target

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

- enableLatchInternal:

    Enables the storage of the value of the scale latched to the internal reference

- enableLatchExternal:

    Enables the storage of the value of the scale latched to the external reference

- adcValue:

    The integer value read out by the encoder

- factor:

    Calibration factor to target unit

- setCounter16:

    Set value for 16 bit encoder.

- setCounter32:

    Set value for 32 bit encoder.

- ssiCoding:

    Binary coding or grey coding. False - Binary; True - Grey

- ssiFrameType:

    Length of the SSI data frame.

- ssiFrameSize:

    Not documented.

- ssiDataLength:

    Not documented.

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

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

###### TRACEYCOMP_SPB_2

Instance id: | LA1_LAS_PPL/ENC/TRACEYCOMP_SPB_2
Host: | exflcon14n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

Device Schema Description

- _serverId_:

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

- _deviceId_:

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

- _connection_:

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

- visibility:

    Configures who is allowed to see this device at all

- deviceId:

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

- classId:

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

- classVersion:

    The version of the class of this device defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- alarmCondition:

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

- lastCommand:

    The last slot called.

- archive:

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

- useTimeserver:

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

- progress:

    The progress of the current action

- heartbeatInterval:

    The heartbeat interval

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

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

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

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

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

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

- epsilon:

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

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

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

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

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

- maxStateUpdateRate:

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

- noisyStateUpdateRateValue:

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

- isStateUpdateNoisy:

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

- reset:

    Resets the PLC hardware

- enableInterlockedSlots:

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

- disableInterlockedSlots:

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

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

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

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

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

- readHardware:

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

- force:

    ???

- trigger:

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

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- value:

    Encoder read value

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

- start:

    Instructs device to go to started state

- stop:

    Instructs device to go to stopped state

- resetADC:

    Reset ADC’s of FPGA in case of constant line, No signal

- resetDDR2:

    Resets DDR2 in case of constant line, No signal

- deviceFile:

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

- mapDirectory:

    Folder where all xml mapping files are located.

- numberRawSamples:

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

- delay:

    Delay between calibration images.

- skipSamples:

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

- triggerTime:

    Time between Triggers

- triggerTimeStat:

    Histogram of time between Triggers

- trainId:

    Current train ID as read from the FPGA

- config:

    Board related configuration parameters.

- dacNode:

    Set up DAC parameters

- channel_0:

    This is a channel of bunch of other parameters

- channel_1:

    This is a channel of bunch of other parameters

- channel_2:

    This is a channel of bunch of other parameters

- channel_3:

    This is a channel of bunch of other parameters

- channel_4:

    This is a channel of bunch of other parameters

- channel_5:

    This is a channel of bunch of other parameters

- channel_6:

    This is a channel of bunch of other parameters

- channel_7:

    This is a channel of bunch of other parameters

- channel_8:

    This is a channel of bunch of other parameters

- channel_9:

    This is a channel of bunch of other parameters

- semiRawValue:

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

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- timeServerId:

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

- Logger:

    Logging settings

- sendCommand:

    Send command to the instrument.

- replyToCommand:

    Reply to the command send to the instrument.

- gotoErrorOnPollFailure:

    Instrument will go to error if poll fails for all properties.

- autoConnect:

    Set True to automatically connect to device.

- pollingInterval:

    The interval for polling the instrument.

- enableHeartbeat:

    Enable Heartbeat

- heartbeatCommand:

    Text to send as heartbeat

- heartbeatReply:

    Heartbeat reply text

- heartbeatPeriod:

    Heartbeat period

- heartbeatTime:

    Last heartbeat time

- pollingTimeTaken:

    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

- pollNow:

    Poll instrument now!

- _connect_:

    Connects to the device

- disconnect:

    Disconnects from the device

- handshake:

    Set the state of the message roundtrip handshaking.

- baudRate:

    Set the transmit and receive baud rates on the RS-232 port.

- errorCount:

    The number of error records in the queue.

- measureType:

    Set the meter measurement mode (energy or power).

- statisticsMode:

    Set the statistics processing mode (on or off).

- variableDecimation:

    Set the pulse decimation rate (1-99999).

- apertureDiameter:

    Set the aperture diameter.

- wavelength:

    Set the current wavelength.

- gainCompensation:

    Enables or disables the gain compensation.

- gainFactor:

    Set the gain compensation factor.

- range:

    Set the measurement range (maximum expected measurement).

- batchSize:

    Set the statistics batch size.

- restartMode:

    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

- statStart:

    Terminates the current statistical batch and start a new one.

- statStop:

    Terminates the current statistical batch.

- triggerSource:

    Selects the trigger source (INTernal / EXTernal).

- triggerLevel:

    Set the trigger level (no effect when external trigger is selected).

- triggerSlope:

    Selects the external trigger edge (POSitive / NEGative).

- sequenceId:

    Set the sequence ID.

- triggerBus:

    Selects the trigger bus participation mode.

- itemSelect:

    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

- statItemSelect:

    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

- serialNumber:

    The serial number string.

- partNumber:

    The part number.

- modelName:

    The Model Name.

- calibrationDate:

    The calibration date.

- manifacturingDate:

    The manifacturing date.

- defaultWavelength:

    The default wavelength.

- measurementRefreshRate:

    The refresh rate of measurements.

- measurement:

    Last measurement.

- idType:

    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

- cameraId:

    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

- packetDelay:

    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

- autoPacketSize:

    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

- packetSize:

    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

- exposureTime:

    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

- triggerMode:

    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

- triggerActivation:

    This enumeration sets the signal transition needed to activate the selected trigger.

- autoGain:

    Configures automatic gain feature.

- gain:

    Sets the gain of the ADC converter.

- acquisitionMode:

    This property sets the image acquisition mode.

- frameCount:

    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

- xPeak1:

    x-position of peak in first calibration image.

- xFWHM1:

    x-FWHM in first calibration image.

- xPeak2:

    x-position of peak in second calibration image.

- xFWHM2:

    x-FWHM in second calibration image.

- delayUnit:

    Unit of the delay between calibration images.

- useAsCalibrationImage1:

    Use the current image as 1st calibration image.

- useAsCalibrationImage2:

    Use the current image as 2nd calibration image.

- calibrate:

  > perform calibrationStepsNumber steps of calibrationStep size starting and ending in symmetrical places relatively to initial position, both along X and Y, while measuring center of beam position.

  > Use these measurements to calculate axCoef and ayCoef.

  > Assumptions that are made: sin(x) ~= x x(y) axis of TEM parallel to x (y) axis of camera

- calibrationFactor:

    The calibration constant.

- beamShape:

    Time shape of the beam.

- xMinFit:

    Lower limit for the fit.

- xMaxFit:

    Upper limit for the fit.

- fitStatus:

    Error of fit procedure: 1-3 means good fit. See device documentation for further details.

- subtractPedestal:

    Subtract the pedestal, calculated from linear interpolation between first and last point.

- xPeak3:

    x-position of peak in the input image.

- xFWHM3:

    x-FWHM in the input image.

- pulseWidth:

    Duration of the pulse.

- ePulseWidth:

    Uncertainty of the pulse duration arising from fit procedure.

- switchToReady:

    Instructs the amplifier to go to ready state.

- switchOn:

    Instructs the amplifier to go to on state.

- switchOff:

    Instructs the amplifier to go to off state.

- closeShutter2:

    Instructs the amplifier to close Shutter 2.

- openShutter2:

    Instructs the amplifier to open Shutter 2.

- amphosIp:

    The IP address of the Amphos Control.

- amphosPort:

    The port of the Amphos Control.

- stateChanging:

    Laser is currently changing state.

- targetPower:

    Target laser power.

- chillerTemperature:

    Measured temperature of chiller.

- chillerFlow:

    Measured flow of chiller [l/min].

- chillerValvePosition:

    Measured valve position.

- shutter2IsOpen:

    Shutter2 State: False=closed True=open

- lambdaIsBusy:

    Lambda plate is moving.

- laserCurrent:

    Measured current of Amphos400.

- laserTemperature:

    Measured temperature of Amphos400.

- laserHumidity:

    Measured humidity of Amphos400.

- xfelCurrentCW1:

    Measured current of XFEL booster 1 (CW1).

- xfelCurrentCW2:

    Measured current of XFEL booster 1 (CW2).

- xfelCurrentQCW1:

    Measured current of XFEL booster 1 (QCW1).

- xfelCurrentQCW2:

    Measured current of XFEL booster 1 (QCW2).

- xfelCurrentQCW3:

    Measured current of XFEL booster 1 (QCW3).

- xfelCurrentQCW4:

    Measured current of XFEL booster 1 (QCW3).

- xfelTemperature:

    Measured temperature of XFEL booster 1.

- xfelHumidity:

    Measured humidity of XFEL booster 1.

- globalAlarmCondition:

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

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- log:

    Logging settings

- adc:

    fast ADC input device

- selectedAdcChannel:

    fast ADC channel in use for the loop

- maxPeakValue:

    Max absolute value for ADC peak. When peak is above this value step is applied

- tuneStage:

    motor controlling the stage to adjust laser path

- stageStep:

    value of stage tuning step size

- loopPeriod:

    Time interval for feedback cycle

- doublecheckWaitTime:

    after peak is above max, this time is waiting to check itagain, before applying step

- calibStepSize:

    Size of calibration step

- calibStepNum:

    Number of calibration steps

- calibAverageNum:

    number of peak values to be averaged for each calibration step

- reverseDirection:

    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

- conversionFactor:

    micrometers to femtoseconds conversion factor

- adcValueTimeout:

    if ADC value is not updated within this time, device goesin error state

- amphosAmpli:

    Karabo ID of Amphos Laser Amplifier

- triggerDelayDevice:

    Karabo ID of pplDelayControl device, used to read Pockels cell status

- moveToPlus:

    Move to +x position

- moveToMinus:

    Move to -x position

- moveToZero:

    Move to 0 position

- pathToProgramFiles:

    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

- correctionFile:

    The correction (.ct5) file, including path.

- useExternalTrigger:

    Use external trigger (if true) or auto-run (if false).

- startFromMinusX:

    Set loop initial position to -X

- jumpSpeed:

    The up/down jump speed [bits/ms].

- jumpAmplitude:

    The up/down jump amplitude [bits].

- delayTimePlus:

    Delay time, after moving to position +x.

- delayTimeMinus:

    Delay time, after moving to position -x.

- onTargetTolerance:

    The tolerance [bits] when checking that Galvo is on target position.

- onTargetPlus:

    Galvo is currently at +x position _and_ not moving.

- onTargetMinus:

    Galvo is currently at -x position _and_ not moving.

- laserOn:

    The value of the LASERON signal.

- digitalOut1:

    The value of the DIGITAL OUT1 signal.

- stopEventCode:

    Stop event code.

- galvoTemperature:

    Galvanometer scanner temperature.

- servoTemperature:

    Servo board temperature.

- agcVoltage:

    AGC voltage (PD supply voltage).

- dspCoreVoltage:

    DSP core supply voltage (1.8 V).

- dspIoVoltage:

    DSP IO voltage (3.3 V).

- analogSectVoltage:

    Analog section voltage (9 V).

- adConverterVoltage:

    AD converter supply voltage (5 V).

- galvoHeatingOut:

    Relative heating output of the corresponding galvanometer scanner heater.

- beamline:

    Beamline where to operate

- timingDevice:

    Device ID of PPL Delay Control Device

- galvoDevice:

    id of Galvo Controller

- downstreamSpectr1Device:

    Spectrometer 1 (FXE/SCS)

- upstreamSpectr1Device:

    Spectrometer 1 (SPB/SQS)

- currentExperiment:

    Current MASTER experiment (UPSTREAM or DOWNSTREAM)

- currentVersion:

    Current version

- correctionFactorMaster:

    Correction Factor Master

- correctionFactorSlave:

    Correction Factor Slave

- switchProgress:

    Switching Progress

- switchExperiment:

    Procedure to automatically swap between FXE and SPB delay control and Galvo settings

- on:

    Instructs the device to switch on

- off:

    Instructs device to switch off

- lastError:

    Last error message received. Time is set by front-end firmware.

- scpiTimeout:

    The SCPI communication timeout.

- baseFreq:

    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

- frontendReset:

    send reset command

- s7ack:

    acknowledge to s7 command

- s8ack:

    acknowledge to s8 command

- s9ack:

    acknowledge to s9 command

- laserEmission:

    True when laser ON, false when OFF

- generalStatus:

    True = OK, False = not OK

- temperatureStatus:

    True = OK, False = not OK

- delayBoardStatus:

    True = OK, False = not OK

- inputPin0Status:

    True = OK, False = not OK

- inputPin4Status:

    True = OK, False = not OK

- pd1Voltage:

    Photodiode 1 (TAB 2) voltage

- pd1VoltageAverage:

    Averaged PD1 (TAB 2) voltage

- pd2Voltage:

    Photodiode 2 (TAB 5) voltage

- pd2VoltageAverage:

    Averaged PD2 (TAB 5) voltage

- pd3Voltage:

    PD3 (SPCO 1) voltage

- pd3VoltageAverage:

    Averaged PD3 (SPCO 1) voltage

- pd4Voltage:

    PD4 (TAB 7) voltage

- pd4VoltageAverage:

    Averaged PD4 (TAB 7) voltage

- pd5Voltage:

    PD5 (SPCO2) voltage

- pd5VoltageAverage:

    Averaged PD5 (SPCO2) voltage

- pd6Voltage:

    PD6 voltage

- pd6VoltageAverage:

    Averaged PD6 voltage

- pd7Voltage:

    PD7 voltage

- pd7VoltageAverage:

    Averaged PD7 voltage

- pd8Voltage:

    PD8 voltage

- pd8VoltageAverage:

    Averaged PD8 voltage

- seederOutPower:

    photodiode 1

- xf1OutPower:

    Photodiode 7

- xf2OutPower:

    Photodiode 8

- seederStatus:

    True = OK, False = not OK

- generalSeederStatus:

    True = OK, False = not OK

- hiltiErrorStatus:

    True = OK, False = not OK

- remoteControl:

    if it is false we cannot see it

- regOnOff0:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- regOnOff1:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- setpAX0:

    Variable SetpAx[0] define the setpoint of the servo loop.

- setpAY0:

    Variable SetpAy[0] define the setpoint of the servo loop.

- sumA0:

    Sum signal of angle detector ‘A’

- sumB0:

    Sum signal of position detector ‘B’

- aX0:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY0:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX0:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY0:

    Variable By represents the measured position deviation in y direction from zero position

- rAX0:

    Regulator Output Ax

- rAY0:

    Regulator Output Ay

- rBX0:

    Regulator Output Bx

- rBY0:

    Regulator Output By

- rAXM0:

    Regulator Output AxM

- rAYM0:

    Regulator Output AyM

- rBXM0:

    Regulator Output BxM

- rBYM0:

    Regulator Output ByM

- setpAX1:

    Variable SetpAx[1] define the setpoint of the servo loop.

- setpAY1:

    Variable SetpAy[1] define the setpoint of the servo loop.

- sumA1:

    Sum signal of angle detector ‘A’

- sumB1:

    Sum signal of position detector ‘B’

- aX1:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY1:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX1:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY1:

    Variable By represents the measured position deviation in y direction from zero position

- rAX1:

    Regulator Output Ax

- rAY1:

    Regulator Output Ay

- rBX1:

    Regulator Output Bx

- rBY1:

    Regulator Output By

- rAXM1:

    Regulator Output AxM

- rAYM1:

    Regulator Output AyM

- rBXM1:

    Regulator Output BxM

- rBYM1:

    Regulator Output ByM

- stage1Id:

    Karabo device ID of first grating motor

- stage2Id:

    Karabo device ID of first grating motor

- tunnel:

    Location where doocs_device is deployed (e.g. ‘SASE1’)

- labx2MName:

    DOOCS name of X2 Master doocs_device

- labx2SName:

    DOOCS name of X2 Slave doocs_device

- timingShifterName:

    DOOCS name of Phase Shifter doocs_device

- manualTuning:

    Manual Tuning Enable

- useShifter:

    Set to True if optical synchronization is available

- midTsValue:

    Mid Value of Phase Shifter

- maxTsDelay:

    Maximum delay to add/subtract to phase shifter position

- maxTsJitter:

    Maximum allowed jitter

- laserOpModeList:

    Select Laser Op Mode

- activeLaserOpMode:

    Active Op laser Mode

- laserOpModeListApply:

    Apply Laser Operation Mode

- dmBCCAuto:

    Automatic loop on/off

- pCellState:

    Status of Pockels Cell, True = On

- pCellOn:

    Set Pockels cell on

- pCellOff:

    Set Pockels cell off

- AOMState:

    Status of AOM, True = On

- AOMOn:

    Set AOM on

- AOMOff:

    Set AOM off

- maxAllowedPcPhase:

    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

- mPCCLKPhase:

    Master PC Phase

- mSWPCCLKPhase:

    Master SW PC Phase

- mBurstWidth:

    Master burst width [us]

- mBurstWidthApply:

    Apply m Burst Width

- mBurstStart:

    Begining of the bursts the slave burst is +50ms)

- mBurstStartsms:

    Master burst starts pos. [us]

- sBurstStartsms:

    Sleve burst starts pos. [us]

- smBurstDiff:

    Different between muster and slave burst positione

- sPCCLKPhase:

    Master PC Phase

- sSWPCCLKPhase:

    Slave software PC PHase

- sBurstWidth:

    Slave burst width [us]

- sBurstWidthApply:

    Apply S Burst width

- delayBPMaster:

    Current delay of the master bunch pattern in clock unit (machine)

- delayBPMasterP:

    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterM:

    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterP24:

    Increment Master Bunch Pattern delay by 24 clock unit

- delayBPMasterM24:

    Decrement Master Bunch Pattern delay by 24 clock unit

- delayBPSlave:

    Current delay of the slave bunch pattern in clock unit (machine)

- delayBPSlaveP:

    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveM:

    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveP24:

    Increment Slave Bunch Pattern delay by 24 clock unit

- delayBPSlaveM24:

    Decrement Slave Bunch Pattern delay by 24 clock unit

- masterExpPattern:

    Select pattern for master experiment

- slaveExpPattern:

    Select pattern for slave experiment

- currentLaserPatterns:

    Current Laser Patterns

- currentMasterLaserPattern:

    Current Master Laser Patterns

- currentSlaveLaserPattern:

    Current Slave Laser Patterns

- currentSlaveLaserPatternN:

    Current Slave Laser Pattern

- fineDelayMaxCounts:

    Fine delay - maximum count number

- fineDelayValue:

    fine delay count value

- fineDelayValueT:

    fine delay time value

- fineDelayP:

    Increment fine delay

- fineDelayM:

    Decrement fine delay

- fineDelay9nsChange:

    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

- fineDelay9ns:

    Change Fine Delay by 9 ns

- minTsPosition:

    Minimum Timing Shifter Delay

- maxTsPosition:

    Maximum Timing Shifter Delay

- currentTsPosition:

    current value of time shifter position

- requestedTsDelay:

    Delay to apply to the phase shifter

- DelayTsChange:

    Change phase shifter by requested value

- relAbsolutTsPos:

    True for relative, False for absolute

- stopPsChange:

    Abort phase shift change

- opticalSynch:

    Display status of optical synchronization

- opticalSynchLock:

    Display lock status of optical synchronization

- opticalSynchJitter:

    Display status of optical synchronization jitter

- opticalSynchMode:

    Optical synch. mode (RF / Optical)

- setOpticalDelay:

    Delay to apply to optical delay line

- applyOpticalDelay:

    change the optical delay by requeste value

- currentOpticalDelay:

    Current position of optical delay

- relAbsolutDelayLine:

    True for relative, False for absolute

- TsJitter:

    Optical Synchronization Jitter

- triggerFE_DOWNSTREAM:

    Current trigger delay FE DOWNSTREAM

- triggerFE_UPSTREAM:

    Current trigger delay FE UPSTREAM

- getCurrentHardwareStatus:

    Read configuration from hardware

- lastShiftDelay:

    FE delay value from the prevoius shift

- setLastShiftDelay:

    Bring the delay to position from the previus shift

- clearLock:

    In case of STATE == changing bring the state to Normal

- mPCCLKPhaseSetValue:

    Master PC CLK Phase Value

- sPCCLKPhaseSetValue:

    Slave PC CLK Phase Value

- delayBPMasterSetValue:

    Master BP delay Value

- delayBPSlaveSetValue:

    Slave BP delay Value

- resetError:

    Reset error state

- upstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for upstream instrument

- downstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for downstream instrument

- shiftChange:

    Swaps MASTER and SLAVE properties between upstream and downstream instrument

- isOxcActive:

    Status of optical lock (True: OPTICAL mode, False: RF mode)

- requestedDelay:

    Relative delay to be applied by delay change (Trigger Position)

- delayChange:

    Change delay value by applying (relative) offset

- mPCCLKPhaseP:

    Increment PC master Phase

- mPCCLKPhaseM:

    Decrement PC master Phase

- sPCCLKPhaseP:

    Increment slave PC Phase

- sPCCLKPhaseM:

    Decrement slave PC phase

- savemSWPCCLKPhase:

    Save new software phase value for PCm

- savesSWPCCLKPhase:

    Save new software phase value for PCs

- mBurstStartApply:

    Apply Burst Start Pos

- takemidTsValue:

    Take mid value of phase shifter

- logBoardsStatus:

    JSON string describing master and slave board settings.Usually updated when user actions are taken

- logFineDelay:

    JSON string describing fine delay settings.Usually updated when user actions are taken

- imgprocDevice:

    Device ID of image processor used for feedback

- temDevice:

    id of tem device

- temChannel:

    TEM channel to be controlled

- xCoefWeight:

    weight of X coefficient

- yCoefWeight:

    weight of Y coefficient

- axCoefOld:

    Value of Ax Coefficient saved prior to calibration

- ayCoefOld:

    Value of Ay Coefficient saved prior to calibration

- xBeamCenterTarget:

    desired value for Beam Center X coordinate

- yBeamCenterTarget:

    desired value for Beam Center Y coordinate

- beamCenterMaxDisplacement:

    maximum allowed displacement for Center of Mass from target position

- maxTemDrift:

    Maximum value allowed for TEM drift

- averageNumber:

    number of values of beam center coordinates to average

- timeoutImageProcessorValues:

    Time to wait before going in error when values from image processor are not updating

- imageSettlementTime:

    Time to wait before reading beam center coordinates aftermoving TEM setpoint

- calibrationStep:

    TEM setpoint step size for calibration

- calibrationStepsNumber:

    Number of TEM calibration steps

- maxTimeNotRegulating:

    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

- setCurrentPosAsTarget:

    Set current beam position as target

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

- enableLatchInternal:

    Enables the storage of the value of the scale latched to the internal reference

- enableLatchExternal:

    Enables the storage of the value of the scale latched to the external reference

- adcValue:

    The integer value read out by the encoder

- factor:

    Calibration factor to target unit

- setCounter16:

    Set value for 16 bit encoder.

- setCounter32:

    Set value for 32 bit encoder.

- ssiCoding:

    Binary coding or grey coding. False - Binary; True - Grey

- ssiFrameType:

    Length of the SSI data frame.

- ssiFrameSize:

    Not documented.

- ssiDataLength:

    Not documented.

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

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

##### GAUGE

[add component documentation]

###### GAUGE_BEAMPIPE_FXE

Instance id: | LA1_LAS_PPL/GAUGE/GAUGE_BEAMPIPE_FXE
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:

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

- _deviceId_:

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

- _connection_:

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

- visibility:

    Configures who is allowed to see this device at all

- deviceId:

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

- classId:

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

- classVersion:

    The version of the class of this device defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- alarmCondition:

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

- lastCommand:

    The last slot called.

- archive:

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

- useTimeserver:

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

- progress:

    The progress of the current action

- heartbeatInterval:

    The heartbeat interval

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

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

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

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

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

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

- epsilon:

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

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

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

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

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

- maxStateUpdateRate:

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

- noisyStateUpdateRateValue:

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

- isStateUpdateNoisy:

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

- reset:

    Resets the PLC hardware

- enableInterlockedSlots:

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

- disableInterlockedSlots:

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

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

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

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

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

- readHardware:

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

- force:

    ???

- trigger:

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

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- value:

    Analog input of ADC.

- scale:

    Scaling factor for analog value.

- offset:

    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!

- start:

    Instructs device to go to started state

- stop:

    Instructs device to go to stopped state

- resetADC:

    Reset ADC’s of FPGA in case of constant line, No signal

- resetDDR2:

    Resets DDR2 in case of constant line, No signal

- deviceFile:

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

- mapDirectory:

    Folder where all xml mapping files are located.

- numberRawSamples:

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

- delay:

    Delay between calibration images.

- skipSamples:

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

- triggerTime:

    Time between Triggers

- triggerTimeStat:

    Histogram of time between Triggers

- trainId:

    Current train ID as read from the FPGA

- config:

    Board related configuration parameters.

- dacNode:

    Set up DAC parameters

- channel_0:

    This is a channel of bunch of other parameters

- channel_1:

    This is a channel of bunch of other parameters

- channel_2:

    This is a channel of bunch of other parameters

- channel_3:

    This is a channel of bunch of other parameters

- channel_4:

    This is a channel of bunch of other parameters

- channel_5:

    This is a channel of bunch of other parameters

- channel_6:

    This is a channel of bunch of other parameters

- channel_7:

    This is a channel of bunch of other parameters

- channel_8:

    This is a channel of bunch of other parameters

- channel_9:

    This is a channel of bunch of other parameters

- semiRawValue:

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

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- timeServerId:

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

- Logger:

    Logging settings

- sendCommand:

    Send command to the instrument.

- replyToCommand:

    Reply to the command send to the instrument.

- gotoErrorOnPollFailure:

    Instrument will go to error if poll fails for all properties.

- autoConnect:

    Set True to automatically connect to device.

- pollingInterval:

    The interval for polling the instrument.

- enableHeartbeat:

    Enable Heartbeat

- heartbeatCommand:

    Text to send as heartbeat

- heartbeatReply:

    Heartbeat reply text

- heartbeatPeriod:

    Heartbeat period

- heartbeatTime:

    Last heartbeat time

- pollingTimeTaken:

    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

- pollNow:

    Poll instrument now!

- _connect_:

    Connects to the device

- disconnect:

    Disconnects from the device

- handshake:

    Set the state of the message roundtrip handshaking.

- baudRate:

    Set the transmit and receive baud rates on the RS-232 port.

- errorCount:

    The number of error records in the queue.

- measureType:

    Set the meter measurement mode (energy or power).

- statisticsMode:

    Set the statistics processing mode (on or off).

- variableDecimation:

    Set the pulse decimation rate (1-99999).

- apertureDiameter:

    Set the aperture diameter.

- wavelength:

    Set the current wavelength.

- gainCompensation:

    Enables or disables the gain compensation.

- gainFactor:

    Set the gain compensation factor.

- range:

    Set the measurement range (maximum expected measurement).

- batchSize:

    Set the statistics batch size.

- restartMode:

    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

- statStart:

    Terminates the current statistical batch and start a new one.

- statStop:

    Terminates the current statistical batch.

- triggerSource:

    Selects the trigger source (INTernal / EXTernal).

- triggerLevel:

    Set the trigger level (no effect when external trigger is selected).

- triggerSlope:

    Selects the external trigger edge (POSitive / NEGative).

- sequenceId:

    Set the sequence ID.

- triggerBus:

    Selects the trigger bus participation mode.

- itemSelect:

    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

- statItemSelect:

    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

- serialNumber:

    The serial number string.

- partNumber:

    The part number.

- modelName:

    The Model Name.

- calibrationDate:

    The calibration date.

- manifacturingDate:

    The manifacturing date.

- defaultWavelength:

    The default wavelength.

- measurementRefreshRate:

    The refresh rate of measurements.

- measurement:

    Last measurement.

- idType:

    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

- cameraId:

    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

- packetDelay:

    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

- autoPacketSize:

    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

- packetSize:

    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

- exposureTime:

    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

- triggerMode:

    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

- triggerActivation:

    This enumeration sets the signal transition needed to activate the selected trigger.

- autoGain:

    Configures automatic gain feature.

- gain:

    Sets the gain of the ADC converter.

- acquisitionMode:

    This property sets the image acquisition mode.

- frameCount:

    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

- xPeak1:

    x-position of peak in first calibration image.

- xFWHM1:

    x-FWHM in first calibration image.

- xPeak2:

    x-position of peak in second calibration image.

- xFWHM2:

    x-FWHM in second calibration image.

- delayUnit:

    Unit of the delay between calibration images.

- useAsCalibrationImage1:

    Use the current image as 1st calibration image.

- useAsCalibrationImage2:

    Use the current image as 2nd calibration image.

- calibrate:

  > perform calibrationStepsNumber steps of calibrationStep size starting and ending in symmetrical places relatively to initial position, both along X and Y, while measuring center of beam position.

  > Use these measurements to calculate axCoef and ayCoef.

  > Assumptions that are made: sin(x) ~= x x(y) axis of TEM parallel to x (y) axis of camera

- calibrationFactor:

    The calibration constant.

- beamShape:

    Time shape of the beam.

- xMinFit:

    Lower limit for the fit.

- xMaxFit:

    Upper limit for the fit.

- fitStatus:

    Error of fit procedure: 1-3 means good fit. See device documentation for further details.

- subtractPedestal:

    Subtract the pedestal, calculated from linear interpolation between first and last point.

- xPeak3:

    x-position of peak in the input image.

- xFWHM3:

    x-FWHM in the input image.

- pulseWidth:

    Duration of the pulse.

- ePulseWidth:

    Uncertainty of the pulse duration arising from fit procedure.

- switchToReady:

    Instructs the amplifier to go to ready state.

- switchOn:

    Instructs the amplifier to go to on state.

- switchOff:

    Instructs the amplifier to go to off state.

- closeShutter2:

    Instructs the amplifier to close Shutter 2.

- openShutter2:

    Instructs the amplifier to open Shutter 2.

- amphosIp:

    The IP address of the Amphos Control.

- amphosPort:

    The port of the Amphos Control.

- stateChanging:

    Laser is currently changing state.

- targetPower:

    Target laser power.

- chillerTemperature:

    Measured temperature of chiller.

- chillerFlow:

    Measured flow of chiller [l/min].

- chillerValvePosition:

    Measured valve position.

- shutter2IsOpen:

    Shutter2 State: False=closed True=open

- lambdaIsBusy:

    Lambda plate is moving.

- laserCurrent:

    Measured current of Amphos400.

- laserTemperature:

    Measured temperature of Amphos400.

- laserHumidity:

    Measured humidity of Amphos400.

- xfelCurrentCW1:

    Measured current of XFEL booster 1 (CW1).

- xfelCurrentCW2:

    Measured current of XFEL booster 1 (CW2).

- xfelCurrentQCW1:

    Measured current of XFEL booster 1 (QCW1).

- xfelCurrentQCW2:

    Measured current of XFEL booster 1 (QCW2).

- xfelCurrentQCW3:

    Measured current of XFEL booster 1 (QCW3).

- xfelCurrentQCW4:

    Measured current of XFEL booster 1 (QCW3).

- xfelTemperature:

    Measured temperature of XFEL booster 1.

- xfelHumidity:

    Measured humidity of XFEL booster 1.

- globalAlarmCondition:

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

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- log:

    Logging settings

- adc:

    fast ADC input device

- selectedAdcChannel:

    fast ADC channel in use for the loop

- maxPeakValue:

    Max absolute value for ADC peak. When peak is above this value step is applied

- tuneStage:

    motor controlling the stage to adjust laser path

- stageStep:

    value of stage tuning step size

- loopPeriod:

    Time interval for feedback cycle

- doublecheckWaitTime:

    after peak is above max, this time is waiting to check itagain, before applying step

- calibStepSize:

    Size of calibration step

- calibStepNum:

    Number of calibration steps

- calibAverageNum:

    number of peak values to be averaged for each calibration step

- reverseDirection:

    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

- conversionFactor:

    micrometers to femtoseconds conversion factor

- adcValueTimeout:

    if ADC value is not updated within this time, device goesin error state

- amphosAmpli:

    Karabo ID of Amphos Laser Amplifier

- triggerDelayDevice:

    Karabo ID of pplDelayControl device, used to read Pockels cell status

- moveToPlus:

    Move to +x position

- moveToMinus:

    Move to -x position

- moveToZero:

    Move to 0 position

- pathToProgramFiles:

    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

- correctionFile:

    The correction (.ct5) file, including path.

- useExternalTrigger:

    Use external trigger (if true) or auto-run (if false).

- startFromMinusX:

    Set loop initial position to -X

- jumpSpeed:

    The up/down jump speed [bits/ms].

- jumpAmplitude:

    The up/down jump amplitude [bits].

- delayTimePlus:

    Delay time, after moving to position +x.

- delayTimeMinus:

    Delay time, after moving to position -x.

- onTargetTolerance:

    The tolerance [bits] when checking that Galvo is on target position.

- onTargetPlus:

    Galvo is currently at +x position _and_ not moving.

- onTargetMinus:

    Galvo is currently at -x position _and_ not moving.

- laserOn:

    The value of the LASERON signal.

- digitalOut1:

    The value of the DIGITAL OUT1 signal.

- stopEventCode:

    Stop event code.

- galvoTemperature:

    Galvanometer scanner temperature.

- servoTemperature:

    Servo board temperature.

- agcVoltage:

    AGC voltage (PD supply voltage).

- dspCoreVoltage:

    DSP core supply voltage (1.8 V).

- dspIoVoltage:

    DSP IO voltage (3.3 V).

- analogSectVoltage:

    Analog section voltage (9 V).

- adConverterVoltage:

    AD converter supply voltage (5 V).

- galvoHeatingOut:

    Relative heating output of the corresponding galvanometer scanner heater.

- beamline:

    Beamline where to operate

- timingDevice:

    Device ID of PPL Delay Control Device

- galvoDevice:

    id of Galvo Controller

- downstreamSpectr1Device:

    Spectrometer 1 (FXE/SCS)

- upstreamSpectr1Device:

    Spectrometer 1 (SPB/SQS)

- currentExperiment:

    Current MASTER experiment (UPSTREAM or DOWNSTREAM)

- currentVersion:

    Current version

- correctionFactorMaster:

    Correction Factor Master

- correctionFactorSlave:

    Correction Factor Slave

- switchProgress:

    Switching Progress

- switchExperiment:

    Procedure to automatically swap between FXE and SPB delay control and Galvo settings

- on:

    Instructs the device to switch on

- off:

    Instructs device to switch off

- lastError:

    Last error message received. Time is set by front-end firmware.

- scpiTimeout:

    The SCPI communication timeout.

- baseFreq:

    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

- frontendReset:

    send reset command

- s7ack:

    acknowledge to s7 command

- s8ack:

    acknowledge to s8 command

- s9ack:

    acknowledge to s9 command

- laserEmission:

    True when laser ON, false when OFF

- generalStatus:

    True = OK, False = not OK

- temperatureStatus:

    True = OK, False = not OK

- delayBoardStatus:

    True = OK, False = not OK

- inputPin0Status:

    True = OK, False = not OK

- inputPin4Status:

    True = OK, False = not OK

- pd1Voltage:

    Photodiode 1 (TAB 2) voltage

- pd1VoltageAverage:

    Averaged PD1 (TAB 2) voltage

- pd2Voltage:

    Photodiode 2 (TAB 5) voltage

- pd2VoltageAverage:

    Averaged PD2 (TAB 5) voltage

- pd3Voltage:

    PD3 (SPCO 1) voltage

- pd3VoltageAverage:

    Averaged PD3 (SPCO 1) voltage

- pd4Voltage:

    PD4 (TAB 7) voltage

- pd4VoltageAverage:

    Averaged PD4 (TAB 7) voltage

- pd5Voltage:

    PD5 (SPCO2) voltage

- pd5VoltageAverage:

    Averaged PD5 (SPCO2) voltage

- pd6Voltage:

    PD6 voltage

- pd6VoltageAverage:

    Averaged PD6 voltage

- pd7Voltage:

    PD7 voltage

- pd7VoltageAverage:

    Averaged PD7 voltage

- pd8Voltage:

    PD8 voltage

- pd8VoltageAverage:

    Averaged PD8 voltage

- seederOutPower:

    photodiode 1

- xf1OutPower:

    Photodiode 7

- xf2OutPower:

    Photodiode 8

- seederStatus:

    True = OK, False = not OK

- generalSeederStatus:

    True = OK, False = not OK

- hiltiErrorStatus:

    True = OK, False = not OK

- remoteControl:

    if it is false we cannot see it

- regOnOff0:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- regOnOff1:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- setpAX0:

    Variable SetpAx[0] define the setpoint of the servo loop.

- setpAY0:

    Variable SetpAy[0] define the setpoint of the servo loop.

- sumA0:

    Sum signal of angle detector ‘A’

- sumB0:

    Sum signal of position detector ‘B’

- aX0:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY0:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX0:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY0:

    Variable By represents the measured position deviation in y direction from zero position

- rAX0:

    Regulator Output Ax

- rAY0:

    Regulator Output Ay

- rBX0:

    Regulator Output Bx

- rBY0:

    Regulator Output By

- rAXM0:

    Regulator Output AxM

- rAYM0:

    Regulator Output AyM

- rBXM0:

    Regulator Output BxM

- rBYM0:

    Regulator Output ByM

- setpAX1:

    Variable SetpAx[1] define the setpoint of the servo loop.

- setpAY1:

    Variable SetpAy[1] define the setpoint of the servo loop.

- sumA1:

    Sum signal of angle detector ‘A’

- sumB1:

    Sum signal of position detector ‘B’

- aX1:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY1:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX1:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY1:

    Variable By represents the measured position deviation in y direction from zero position

- rAX1:

    Regulator Output Ax

- rAY1:

    Regulator Output Ay

- rBX1:

    Regulator Output Bx

- rBY1:

    Regulator Output By

- rAXM1:

    Regulator Output AxM

- rAYM1:

    Regulator Output AyM

- rBXM1:

    Regulator Output BxM

- rBYM1:

    Regulator Output ByM

- stage1Id:

    Karabo device ID of first grating motor

- stage2Id:

    Karabo device ID of first grating motor

- tunnel:

    Location where doocs_device is deployed (e.g. ‘SASE1’)

- labx2MName:

    DOOCS name of X2 Master doocs_device

- labx2SName:

    DOOCS name of X2 Slave doocs_device

- timingShifterName:

    DOOCS name of Phase Shifter doocs_device

- manualTuning:

    Manual Tuning Enable

- useShifter:

    Set to True if optical synchronization is available

- midTsValue:

    Mid Value of Phase Shifter

- maxTsDelay:

    Maximum delay to add/subtract to phase shifter position

- maxTsJitter:

    Maximum allowed jitter

- laserOpModeList:

    Select Laser Op Mode

- activeLaserOpMode:

    Active Op laser Mode

- laserOpModeListApply:

    Apply Laser Operation Mode

- dmBCCAuto:

    Automatic loop on/off

- pCellState:

    Status of Pockels Cell, True = On

- pCellOn:

    Set Pockels cell on

- pCellOff:

    Set Pockels cell off

- AOMState:

    Status of AOM, True = On

- AOMOn:

    Set AOM on

- AOMOff:

    Set AOM off

- maxAllowedPcPhase:

    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

- mPCCLKPhase:

    Master PC Phase

- mSWPCCLKPhase:

    Master SW PC Phase

- mBurstWidth:

    Master burst width [us]

- mBurstWidthApply:

    Apply m Burst Width

- mBurstStart:

    Begining of the bursts the slave burst is +50ms)

- mBurstStartsms:

    Master burst starts pos. [us]

- sBurstStartsms:

    Sleve burst starts pos. [us]

- smBurstDiff:

    Different between muster and slave burst positione

- sPCCLKPhase:

    Master PC Phase

- sSWPCCLKPhase:

    Slave software PC PHase

- sBurstWidth:

    Slave burst width [us]

- sBurstWidthApply:

    Apply S Burst width

- delayBPMaster:

    Current delay of the master bunch pattern in clock unit (machine)

- delayBPMasterP:

    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterM:

    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterP24:

    Increment Master Bunch Pattern delay by 24 clock unit

- delayBPMasterM24:

    Decrement Master Bunch Pattern delay by 24 clock unit

- delayBPSlave:

    Current delay of the slave bunch pattern in clock unit (machine)

- delayBPSlaveP:

    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveM:

    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveP24:

    Increment Slave Bunch Pattern delay by 24 clock unit

- delayBPSlaveM24:

    Decrement Slave Bunch Pattern delay by 24 clock unit

- masterExpPattern:

    Select pattern for master experiment

- slaveExpPattern:

    Select pattern for slave experiment

- currentLaserPatterns:

    Current Laser Patterns

- currentMasterLaserPattern:

    Current Master Laser Patterns

- currentSlaveLaserPattern:

    Current Slave Laser Patterns

- currentSlaveLaserPatternN:

    Current Slave Laser Pattern

- fineDelayMaxCounts:

    Fine delay - maximum count number

- fineDelayValue:

    fine delay count value

- fineDelayValueT:

    fine delay time value

- fineDelayP:

    Increment fine delay

- fineDelayM:

    Decrement fine delay

- fineDelay9nsChange:

    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

- fineDelay9ns:

    Change Fine Delay by 9 ns

- minTsPosition:

    Minimum Timing Shifter Delay

- maxTsPosition:

    Maximum Timing Shifter Delay

- currentTsPosition:

    current value of time shifter position

- requestedTsDelay:

    Delay to apply to the phase shifter

- DelayTsChange:

    Change phase shifter by requested value

- relAbsolutTsPos:

    True for relative, False for absolute

- stopPsChange:

    Abort phase shift change

- opticalSynch:

    Display status of optical synchronization

- opticalSynchLock:

    Display lock status of optical synchronization

- opticalSynchJitter:

    Display status of optical synchronization jitter

- opticalSynchMode:

    Optical synch. mode (RF / Optical)

- setOpticalDelay:

    Delay to apply to optical delay line

- applyOpticalDelay:

    change the optical delay by requeste value

- currentOpticalDelay:

    Current position of optical delay

- relAbsolutDelayLine:

    True for relative, False for absolute

- TsJitter:

    Optical Synchronization Jitter

- triggerFE_DOWNSTREAM:

    Current trigger delay FE DOWNSTREAM

- triggerFE_UPSTREAM:

    Current trigger delay FE UPSTREAM

- getCurrentHardwareStatus:

    Read configuration from hardware

- lastShiftDelay:

    FE delay value from the prevoius shift

- setLastShiftDelay:

    Bring the delay to position from the previus shift

- clearLock:

    In case of STATE == changing bring the state to Normal

- mPCCLKPhaseSetValue:

    Master PC CLK Phase Value

- sPCCLKPhaseSetValue:

    Slave PC CLK Phase Value

- delayBPMasterSetValue:

    Master BP delay Value

- delayBPSlaveSetValue:

    Slave BP delay Value

- resetError:

    Reset error state

- upstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for upstream instrument

- downstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for downstream instrument

- shiftChange:

    Swaps MASTER and SLAVE properties between upstream and downstream instrument

- isOxcActive:

    Status of optical lock (True: OPTICAL mode, False: RF mode)

- requestedDelay:

    Relative delay to be applied by delay change (Trigger Position)

- delayChange:

    Change delay value by applying (relative) offset

- mPCCLKPhaseP:

    Increment PC master Phase

- mPCCLKPhaseM:

    Decrement PC master Phase

- sPCCLKPhaseP:

    Increment slave PC Phase

- sPCCLKPhaseM:

    Decrement slave PC phase

- savemSWPCCLKPhase:

    Save new software phase value for PCm

- savesSWPCCLKPhase:

    Save new software phase value for PCs

- mBurstStartApply:

    Apply Burst Start Pos

- takemidTsValue:

    Take mid value of phase shifter

- logBoardsStatus:

    JSON string describing master and slave board settings.Usually updated when user actions are taken

- logFineDelay:

    JSON string describing fine delay settings.Usually updated when user actions are taken

- imgprocDevice:

    Device ID of image processor used for feedback

- temDevice:

    id of tem device

- temChannel:

    TEM channel to be controlled

- xCoefWeight:

    weight of X coefficient

- yCoefWeight:

    weight of Y coefficient

- axCoefOld:

    Value of Ax Coefficient saved prior to calibration

- ayCoefOld:

    Value of Ay Coefficient saved prior to calibration

- xBeamCenterTarget:

    desired value for Beam Center X coordinate

- yBeamCenterTarget:

    desired value for Beam Center Y coordinate

- beamCenterMaxDisplacement:

    maximum allowed displacement for Center of Mass from target position

- maxTemDrift:

    Maximum value allowed for TEM drift

- averageNumber:

    number of values of beam center coordinates to average

- timeoutImageProcessorValues:

    Time to wait before going in error when values from image processor are not updating

- imageSettlementTime:

    Time to wait before reading beam center coordinates aftermoving TEM setpoint

- calibrationStep:

    TEM setpoint step size for calibration

- calibrationStepsNumber:

    Number of TEM calibration steps

- maxTimeNotRegulating:

    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

- setCurrentPosAsTarget:

    Set current beam position as target

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

- enableLatchInternal:

    Enables the storage of the value of the scale latched to the internal reference

- enableLatchExternal:

    Enables the storage of the value of the scale latched to the external reference

- adcValue:

    The integer value read out by the encoder

- factor:

    Calibration factor to target unit

- setCounter16:

    Set value for 16 bit encoder.

- setCounter32:

    Set value for 32 bit encoder.

- ssiCoding:

    Binary coding or grey coding. False - Binary; True - Grey

- ssiFrameType:

    Length of the SSI data frame.

- ssiFrameSize:

    Not documented.

- ssiDataLength:

    Not documented.

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

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

###### GAUGE_BEAMPIPE_SPB

Instance id: | LA1_LAS_PPL/GAUGE/GAUGE_BEAMPIPE_SPB
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:

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

- _deviceId_:

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

- _connection_:

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

- visibility:

    Configures who is allowed to see this device at all

- deviceId:

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

- classId:

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

- classVersion:

    The version of the class of this device defined in KARABO_CLASSINFO

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server on which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- alarmCondition:

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

- lastCommand:

    The last slot called.

- archive:

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

- useTimeserver:

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

- progress:

    The progress of the current action

- heartbeatInterval:

    The heartbeat interval

- performanceStatistics:

    Accumulates some statistics

- version:

    Version of this Karabo device.

- beckhoffComDevice:

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

- functionBlockName:

    The type of the firmware block.

- fwInstanceName:

    The name of the firmware block instance.

- fwVersion:

    The version of the PLC framework.

- terminal:

    ???

- hardwareStatusBitField:

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

- hardwareState:

    The current state of the hardware decoded

- hardwareRegion:

    The current region of the hardware decoded

- hardwareErrorDescriptor:

    This word encodes in bits describing the hardware error

- hardwareErrorDescription:

    Error Code description

- waitingFor:

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

- epsilon:

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

- interlockReadOnly:

    Defines whether interlock conditions are configurable from this interface.

- interlockOn:

    Defines whether interlock surveillance is on or off.

- interlockOk:

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

- busy:

    Defines whether the PLC softdevice is busy.

- disableEpsilonFeedback:

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

- maxStateUpdateRate:

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

- noisyStateUpdateRateValue:

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

- isStateUpdateNoisy:

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

- reset:

    Resets the PLC hardware

- enableInterlockedSlots:

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

- disableInterlockedSlots:

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

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

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

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

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

- readHardware:

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

- force:

    ???

- trigger:

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

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- value:

    Analog input of ADC.

- scale:

    Scaling factor for analog value.

- offset:

    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!

- start:

    Instructs device to go to started state

- stop:

    Instructs device to go to stopped state

- resetADC:

    Reset ADC’s of FPGA in case of constant line, No signal

- resetDDR2:

    Resets DDR2 in case of constant line, No signal

- deviceFile:

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

- mapDirectory:

    Folder where all xml mapping files are located.

- numberRawSamples:

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

- delay:

    Delay between calibration images.

- skipSamples:

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

- triggerTime:

    Time between Triggers

- triggerTimeStat:

    Histogram of time between Triggers

- trainId:

    Current train ID as read from the FPGA

- config:

    Board related configuration parameters.

- dacNode:

    Set up DAC parameters

- channel_0:

    This is a channel of bunch of other parameters

- channel_1:

    This is a channel of bunch of other parameters

- channel_2:

    This is a channel of bunch of other parameters

- channel_3:

    This is a channel of bunch of other parameters

- channel_4:

    This is a channel of bunch of other parameters

- channel_5:

    This is a channel of bunch of other parameters

- channel_6:

    This is a channel of bunch of other parameters

- channel_7:

    This is a channel of bunch of other parameters

- channel_8:

    This is a channel of bunch of other parameters

- channel_9:

    This is a channel of bunch of other parameters

- semiRawValue:

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

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- timeServerId:

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

- Logger:

    Logging settings

- sendCommand:

    Send command to the instrument.

- replyToCommand:

    Reply to the command send to the instrument.

- gotoErrorOnPollFailure:

    Instrument will go to error if poll fails for all properties.

- autoConnect:

    Set True to automatically connect to device.

- pollingInterval:

    The interval for polling the instrument.

- enableHeartbeat:

    Enable Heartbeat

- heartbeatCommand:

    Text to send as heartbeat

- heartbeatReply:

    Heartbeat reply text

- heartbeatPeriod:

    Heartbeat period

- heartbeatTime:

    Last heartbeat time

- pollingTimeTaken:

    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

- pollNow:

    Poll instrument now!

- _connect_:

    Connects to the device

- disconnect:

    Disconnects from the device

- handshake:

    Set the state of the message roundtrip handshaking.

- baudRate:

    Set the transmit and receive baud rates on the RS-232 port.

- errorCount:

    The number of error records in the queue.

- measureType:

    Set the meter measurement mode (energy or power).

- statisticsMode:

    Set the statistics processing mode (on or off).

- variableDecimation:

    Set the pulse decimation rate (1-99999).

- apertureDiameter:

    Set the aperture diameter.

- wavelength:

    Set the current wavelength.

- gainCompensation:

    Enables or disables the gain compensation.

- gainFactor:

    Set the gain compensation factor.

- range:

    Set the measurement range (maximum expected measurement).

- batchSize:

    Set the statistics batch size.

- restartMode:

    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

- statStart:

    Terminates the current statistical batch and start a new one.

- statStop:

    Terminates the current statistical batch.

- triggerSource:

    Selects the trigger source (INTernal / EXTernal).

- triggerLevel:

    Set the trigger level (no effect when external trigger is selected).

- triggerSlope:

    Selects the external trigger edge (POSitive / NEGative).

- sequenceId:

    Set the sequence ID.

- triggerBus:

    Selects the trigger bus participation mode.

- itemSelect:

    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

- statItemSelect:

    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

- serialNumber:

    The serial number string.

- partNumber:

    The part number.

- modelName:

    The Model Name.

- calibrationDate:

    The calibration date.

- manifacturingDate:

    The manifacturing date.

- defaultWavelength:

    The default wavelength.

- measurementRefreshRate:

    The refresh rate of measurements.

- measurement:

    Last measurement.

- idType:

    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

- cameraId:

    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

- packetDelay:

    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

- autoPacketSize:

    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

- packetSize:

    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

- exposureTime:

    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

- triggerMode:

    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

- triggerActivation:

    This enumeration sets the signal transition needed to activate the selected trigger.

- autoGain:

    Configures automatic gain feature.

- gain:

    Sets the gain of the ADC converter.

- acquisitionMode:

    This property sets the image acquisition mode.

- frameCount:

    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

- xPeak1:

    x-position of peak in first calibration image.

- xFWHM1:

    x-FWHM in first calibration image.

- xPeak2:

    x-position of peak in second calibration image.

- xFWHM2:

    x-FWHM in second calibration image.

- delayUnit:

    Unit of the delay between calibration images.

- useAsCalibrationImage1:

    Use the current image as 1st calibration image.

- useAsCalibrationImage2:

    Use the current image as 2nd calibration image.

- calibrate:

  > perform calibrationStepsNumber steps of calibrationStep size starting and ending in symmetrical places relatively to initial position, both along X and Y, while measuring center of beam position.

  > Use these measurements to calculate axCoef and ayCoef.

  > Assumptions that are made: sin(x) ~= x x(y) axis of TEM parallel to x (y) axis of camera

- calibrationFactor:

    The calibration constant.

- beamShape:

    Time shape of the beam.

- xMinFit:

    Lower limit for the fit.

- xMaxFit:

    Upper limit for the fit.

- fitStatus:

    Error of fit procedure: 1-3 means good fit. See device documentation for further details.

- subtractPedestal:

    Subtract the pedestal, calculated from linear interpolation between first and last point.

- xPeak3:

    x-position of peak in the input image.

- xFWHM3:

    x-FWHM in the input image.

- pulseWidth:

    Duration of the pulse.

- ePulseWidth:

    Uncertainty of the pulse duration arising from fit procedure.

- switchToReady:

    Instructs the amplifier to go to ready state.

- switchOn:

    Instructs the amplifier to go to on state.

- switchOff:

    Instructs the amplifier to go to off state.

- closeShutter2:

    Instructs the amplifier to close Shutter 2.

- openShutter2:

    Instructs the amplifier to open Shutter 2.

- amphosIp:

    The IP address of the Amphos Control.

- amphosPort:

    The port of the Amphos Control.

- stateChanging:

    Laser is currently changing state.

- targetPower:

    Target laser power.

- chillerTemperature:

    Measured temperature of chiller.

- chillerFlow:

    Measured flow of chiller [l/min].

- chillerValvePosition:

    Measured valve position.

- shutter2IsOpen:

    Shutter2 State: False=closed True=open

- lambdaIsBusy:

    Lambda plate is moving.

- laserCurrent:

    Measured current of Amphos400.

- laserTemperature:

    Measured temperature of Amphos400.

- laserHumidity:

    Measured humidity of Amphos400.

- xfelCurrentCW1:

    Measured current of XFEL booster 1 (CW1).

- xfelCurrentCW2:

    Measured current of XFEL booster 1 (CW2).

- xfelCurrentQCW1:

    Measured current of XFEL booster 1 (QCW1).

- xfelCurrentQCW2:

    Measured current of XFEL booster 1 (QCW2).

- xfelCurrentQCW3:

    Measured current of XFEL booster 1 (QCW3).

- xfelCurrentQCW4:

    Measured current of XFEL booster 1 (QCW3).

- xfelTemperature:

    Measured temperature of XFEL booster 1.

- xfelHumidity:

    Measured humidity of XFEL booster 1.

- globalAlarmCondition:

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

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- log:

    Logging settings

- adc:

    fast ADC input device

- selectedAdcChannel:

    fast ADC channel in use for the loop

- maxPeakValue:

    Max absolute value for ADC peak. When peak is above this value step is applied

- tuneStage:

    motor controlling the stage to adjust laser path

- stageStep:

    value of stage tuning step size

- loopPeriod:

    Time interval for feedback cycle

- doublecheckWaitTime:

    after peak is above max, this time is waiting to check itagain, before applying step

- calibStepSize:

    Size of calibration step

- calibStepNum:

    Number of calibration steps

- calibAverageNum:

    number of peak values to be averaged for each calibration step

- reverseDirection:

    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

- conversionFactor:

    micrometers to femtoseconds conversion factor

- adcValueTimeout:

    if ADC value is not updated within this time, device goesin error state

- amphosAmpli:

    Karabo ID of Amphos Laser Amplifier

- triggerDelayDevice:

    Karabo ID of pplDelayControl device, used to read Pockels cell status

- moveToPlus:

    Move to +x position

- moveToMinus:

    Move to -x position

- moveToZero:

    Move to 0 position

- pathToProgramFiles:

    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

- correctionFile:

    The correction (.ct5) file, including path.

- useExternalTrigger:

    Use external trigger (if true) or auto-run (if false).

- startFromMinusX:

    Set loop initial position to -X

- jumpSpeed:

    The up/down jump speed [bits/ms].

- jumpAmplitude:

    The up/down jump amplitude [bits].

- delayTimePlus:

    Delay time, after moving to position +x.

- delayTimeMinus:

    Delay time, after moving to position -x.

- onTargetTolerance:

    The tolerance [bits] when checking that Galvo is on target position.

- onTargetPlus:

    Galvo is currently at +x position _and_ not moving.

- onTargetMinus:

    Galvo is currently at -x position _and_ not moving.

- laserOn:

    The value of the LASERON signal.

- digitalOut1:

    The value of the DIGITAL OUT1 signal.

- stopEventCode:

    Stop event code.

- galvoTemperature:

    Galvanometer scanner temperature.

- servoTemperature:

    Servo board temperature.

- agcVoltage:

    AGC voltage (PD supply voltage).

- dspCoreVoltage:

    DSP core supply voltage (1.8 V).

- dspIoVoltage:

    DSP IO voltage (3.3 V).

- analogSectVoltage:

    Analog section voltage (9 V).

- adConverterVoltage:

    AD converter supply voltage (5 V).

- galvoHeatingOut:

    Relative heating output of the corresponding galvanometer scanner heater.

- beamline:

    Beamline where to operate

- timingDevice:

    Device ID of PPL Delay Control Device

- galvoDevice:

    id of Galvo Controller

- downstreamSpectr1Device:

    Spectrometer 1 (FXE/SCS)

- upstreamSpectr1Device:

    Spectrometer 1 (SPB/SQS)

- currentExperiment:

    Current MASTER experiment (UPSTREAM or DOWNSTREAM)

- currentVersion:

    Current version

- correctionFactorMaster:

    Correction Factor Master

- correctionFactorSlave:

    Correction Factor Slave

- switchProgress:

    Switching Progress

- switchExperiment:

    Procedure to automatically swap between FXE and SPB delay control and Galvo settings

- on:

    Instructs the device to switch on

- off:

    Instructs device to switch off

- lastError:

    Last error message received. Time is set by front-end firmware.

- scpiTimeout:

    The SCPI communication timeout.

- baseFreq:

    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

- frontendReset:

    send reset command

- s7ack:

    acknowledge to s7 command

- s8ack:

    acknowledge to s8 command

- s9ack:

    acknowledge to s9 command

- laserEmission:

    True when laser ON, false when OFF

- generalStatus:

    True = OK, False = not OK

- temperatureStatus:

    True = OK, False = not OK

- delayBoardStatus:

    True = OK, False = not OK

- inputPin0Status:

    True = OK, False = not OK

- inputPin4Status:

    True = OK, False = not OK

- pd1Voltage:

    Photodiode 1 (TAB 2) voltage

- pd1VoltageAverage:

    Averaged PD1 (TAB 2) voltage

- pd2Voltage:

    Photodiode 2 (TAB 5) voltage

- pd2VoltageAverage:

    Averaged PD2 (TAB 5) voltage

- pd3Voltage:

    PD3 (SPCO 1) voltage

- pd3VoltageAverage:

    Averaged PD3 (SPCO 1) voltage

- pd4Voltage:

    PD4 (TAB 7) voltage

- pd4VoltageAverage:

    Averaged PD4 (TAB 7) voltage

- pd5Voltage:

    PD5 (SPCO2) voltage

- pd5VoltageAverage:

    Averaged PD5 (SPCO2) voltage

- pd6Voltage:

    PD6 voltage

- pd6VoltageAverage:

    Averaged PD6 voltage

- pd7Voltage:

    PD7 voltage

- pd7VoltageAverage:

    Averaged PD7 voltage

- pd8Voltage:

    PD8 voltage

- pd8VoltageAverage:

    Averaged PD8 voltage

- seederOutPower:

    photodiode 1

- xf1OutPower:

    Photodiode 7

- xf2OutPower:

    Photodiode 8

- seederStatus:

    True = OK, False = not OK

- generalSeederStatus:

    True = OK, False = not OK

- hiltiErrorStatus:

    True = OK, False = not OK

- remoteControl:

    if it is false we cannot see it

- regOnOff0:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- regOnOff1:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- setpAX0:

    Variable SetpAx[0] define the setpoint of the servo loop.

- setpAY0:

    Variable SetpAy[0] define the setpoint of the servo loop.

- sumA0:

    Sum signal of angle detector ‘A’

- sumB0:

    Sum signal of position detector ‘B’

- aX0:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY0:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX0:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY0:

    Variable By represents the measured position deviation in y direction from zero position

- rAX0:

    Regulator Output Ax

- rAY0:

    Regulator Output Ay

- rBX0:

    Regulator Output Bx

- rBY0:

    Regulator Output By

- rAXM0:

    Regulator Output AxM

- rAYM0:

    Regulator Output AyM

- rBXM0:

    Regulator Output BxM

- rBYM0:

    Regulator Output ByM

- setpAX1:

    Variable SetpAx[1] define the setpoint of the servo loop.

- setpAY1:

    Variable SetpAy[1] define the setpoint of the servo loop.

- sumA1:

    Sum signal of angle detector ‘A’

- sumB1:

    Sum signal of position detector ‘B’

- aX1:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY1:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX1:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY1:

    Variable By represents the measured position deviation in y direction from zero position

- rAX1:

    Regulator Output Ax

- rAY1:

    Regulator Output Ay

- rBX1:

    Regulator Output Bx

- rBY1:

    Regulator Output By

- rAXM1:

    Regulator Output AxM

- rAYM1:

    Regulator Output AyM

- rBXM1:

    Regulator Output BxM

- rBYM1:

    Regulator Output ByM

- stage1Id:

    Karabo device ID of first grating motor

- stage2Id:

    Karabo device ID of first grating motor

- tunnel:

    Location where doocs_device is deployed (e.g. ‘SASE1’)

- labx2MName:

    DOOCS name of X2 Master doocs_device

- labx2SName:

    DOOCS name of X2 Slave doocs_device

- timingShifterName:

    DOOCS name of Phase Shifter doocs_device

- manualTuning:

    Manual Tuning Enable

- useShifter:

    Set to True if optical synchronization is available

- midTsValue:

    Mid Value of Phase Shifter

- maxTsDelay:

    Maximum delay to add/subtract to phase shifter position

- maxTsJitter:

    Maximum allowed jitter

- laserOpModeList:

    Select Laser Op Mode

- activeLaserOpMode:

    Active Op laser Mode

- laserOpModeListApply:

    Apply Laser Operation Mode

- dmBCCAuto:

    Automatic loop on/off

- pCellState:

    Status of Pockels Cell, True = On

- pCellOn:

    Set Pockels cell on

- pCellOff:

    Set Pockels cell off

- AOMState:

    Status of AOM, True = On

- AOMOn:

    Set AOM on

- AOMOff:

    Set AOM off

- maxAllowedPcPhase:

    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

- mPCCLKPhase:

    Master PC Phase

- mSWPCCLKPhase:

    Master SW PC Phase

- mBurstWidth:

    Master burst width [us]

- mBurstWidthApply:

    Apply m Burst Width

- mBurstStart:

    Begining of the bursts the slave burst is +50ms)

- mBurstStartsms:

    Master burst starts pos. [us]

- sBurstStartsms:

    Sleve burst starts pos. [us]

- smBurstDiff:

    Different between muster and slave burst positione

- sPCCLKPhase:

    Master PC Phase

- sSWPCCLKPhase:

    Slave software PC PHase

- sBurstWidth:

    Slave burst width [us]

- sBurstWidthApply:

    Apply S Burst width

- delayBPMaster:

    Current delay of the master bunch pattern in clock unit (machine)

- delayBPMasterP:

    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterM:

    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterP24:

    Increment Master Bunch Pattern delay by 24 clock unit

- delayBPMasterM24:

    Decrement Master Bunch Pattern delay by 24 clock unit

- delayBPSlave:

    Current delay of the slave bunch pattern in clock unit (machine)

- delayBPSlaveP:

    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveM:

    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveP24:

    Increment Slave Bunch Pattern delay by 24 clock unit

- delayBPSlaveM24:

    Decrement Slave Bunch Pattern delay by 24 clock unit

- masterExpPattern:

    Select pattern for master experiment

- slaveExpPattern:

    Select pattern for slave experiment

- currentLaserPatterns:

    Current Laser Patterns

- currentMasterLaserPattern:

    Current Master Laser Patterns

- currentSlaveLaserPattern:

    Current Slave Laser Patterns

- currentSlaveLaserPatternN:

    Current Slave Laser Pattern

- fineDelayMaxCounts:

    Fine delay - maximum count number

- fineDelayValue:

    fine delay count value

- fineDelayValueT:

    fine delay time value

- fineDelayP:

    Increment fine delay

- fineDelayM:

    Decrement fine delay

- fineDelay9nsChange:

    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

- fineDelay9ns:

    Change Fine Delay by 9 ns

- minTsPosition:

    Minimum Timing Shifter Delay

- maxTsPosition:

    Maximum Timing Shifter Delay

- currentTsPosition:

    current value of time shifter position

- requestedTsDelay:

    Delay to apply to the phase shifter

- DelayTsChange:

    Change phase shifter by requested value

- relAbsolutTsPos:

    True for relative, False for absolute

- stopPsChange:

    Abort phase shift change

- opticalSynch:

    Display status of optical synchronization

- opticalSynchLock:

    Display lock status of optical synchronization

- opticalSynchJitter:

    Display status of optical synchronization jitter

- opticalSynchMode:

    Optical synch. mode (RF / Optical)

- setOpticalDelay:

    Delay to apply to optical delay line

- applyOpticalDelay:

    change the optical delay by requeste value

- currentOpticalDelay:

    Current position of optical delay

- relAbsolutDelayLine:

    True for relative, False for absolute

- TsJitter:

    Optical Synchronization Jitter

- triggerFE_DOWNSTREAM:

    Current trigger delay FE DOWNSTREAM

- triggerFE_UPSTREAM:

    Current trigger delay FE UPSTREAM

- getCurrentHardwareStatus:

    Read configuration from hardware

- lastShiftDelay:

    FE delay value from the prevoius shift

- setLastShiftDelay:

    Bring the delay to position from the previus shift

- clearLock:

    In case of STATE == changing bring the state to Normal

- mPCCLKPhaseSetValue:

    Master PC CLK Phase Value

- sPCCLKPhaseSetValue:

    Slave PC CLK Phase Value

- delayBPMasterSetValue:

    Master BP delay Value

- delayBPSlaveSetValue:

    Slave BP delay Value

- resetError:

    Reset error state

- upstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for upstream instrument

- downstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for downstream instrument

- shiftChange:

    Swaps MASTER and SLAVE properties between upstream and downstream instrument

- isOxcActive:

    Status of optical lock (True: OPTICAL mode, False: RF mode)

- requestedDelay:

    Relative delay to be applied by delay change (Trigger Position)

- delayChange:

    Change delay value by applying (relative) offset

- mPCCLKPhaseP:

    Increment PC master Phase

- mPCCLKPhaseM:

    Decrement PC master Phase

- sPCCLKPhaseP:

    Increment slave PC Phase

- sPCCLKPhaseM:

    Decrement slave PC phase

- savemSWPCCLKPhase:

    Save new software phase value for PCm

- savesSWPCCLKPhase:

    Save new software phase value for PCs

- mBurstStartApply:

    Apply Burst Start Pos

- takemidTsValue:

    Take mid value of phase shifter

- logBoardsStatus:

    JSON string describing master and slave board settings.Usually updated when user actions are taken

- logFineDelay:

    JSON string describing fine delay settings.Usually updated when user actions are taken

- imgprocDevice:

    Device ID of image processor used for feedback

- temDevice:

    id of tem device

- temChannel:

    TEM channel to be controlled

- xCoefWeight:

    weight of X coefficient

- yCoefWeight:

    weight of Y coefficient

- axCoefOld:

    Value of Ax Coefficient saved prior to calibration

- ayCoefOld:

    Value of Ay Coefficient saved prior to calibration

- xBeamCenterTarget:

    desired value for Beam Center X coordinate

- yBeamCenterTarget:

    desired value for Beam Center Y coordinate

- beamCenterMaxDisplacement:

    maximum allowed displacement for Center of Mass from target position

- maxTemDrift:

    Maximum value allowed for TEM drift

- averageNumber:

    number of values of beam center coordinates to average

- timeoutImageProcessorValues:

    Time to wait before going in error when values from image processor are not updating

- imageSettlementTime:

    Time to wait before reading beam center coordinates aftermoving TEM setpoint

- calibrationStep:

    TEM setpoint step size for calibration

- calibrationStepsNumber:

    Number of TEM calibration steps

- maxTimeNotRegulating:

    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

- setCurrentPosAsTarget:

    Set current beam position as target

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

- enableLatchInternal:

    Enables the storage of the value of the scale latched to the internal reference

- enableLatchExternal:

    Enables the storage of the value of the scale latched to the external reference

- adcValue:

    The integer value read out by the encoder

- factor:

    Calibration factor to target unit

- setCounter16:

    Set value for 16 bit encoder.

- setCounter32:

    Set value for 32 bit encoder.

- ssiCoding:

    Binary coding or grey coding. False - Binary; True - Grey

- ssiFrameType:

    Length of the SSI data frame.

- ssiFrameSize:

    Not documented.

- ssiDataLength:

    Not documented.

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

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

##### MDL

[add component documentation]

###### BECKHOFF_MONITOR

Instance id: | LA1_LAS_PPL/MDL/BECKHOFF_MONITOR
Host: | exflcon14n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
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
Accessible by: |

Warning

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

Device Schema Description

- _serverId_:

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

- _deviceId_:

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

- _connection_:

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

- visibility:

    Configures who is allowed to see this device at all

- deviceId:

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

- classId:

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

- classVersion:

    The version of the class of this device

- karaboVersion:

    The version of the Karabo framework running this device

- serverId:

    The device-server which this device is running on

- hostName:

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

- pid:

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

- state:

    The current state the device is in

- status:

    A more detailed status description

- alarmCondition:

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

- lastCommand:

    The last slot called.

- archive:

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

- useTimeserver:

    Unused - whether 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 this Monitor device

- enableInterlockedSlots:

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

- disableInterlockedSlots:

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

- requestHardwareValues:

    Ask for all property values on the device

- propertiesToPoll:

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

- pollInterval:

    Hardware poll interval in seconds

- propertiesToRead:

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

- readHardware:

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

- force:

    ???

- trigger:

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

- maxUpdateFrequency:

    set to limit maximum update frequency for some values.

- value:

    Analog input of ADC.

- scale:

    Scaling factor for analog value.

- offset:

    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!

- start:

    Instructs device to go to started state

- stop:

    Instructs device to go to stopped state

- resetADC:

    Reset ADC’s of FPGA in case of constant line, No signal

- resetDDR2:

    Resets DDR2 in case of constant line, No signal

- deviceFile:

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

- mapDirectory:

    Folder where all xml mapping files are located.

- numberRawSamples:

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

- delay:

    Delay between calibration images.

- skipSamples:

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

- triggerTime:

    Time between Triggers

- triggerTimeStat:

    Histogram of time between Triggers

- trainId:

    Current train ID as read from the FPGA

- config:

    Board related configuration parameters.

- dacNode:

    Set up DAC parameters

- channel_0:

    This is a channel of bunch of other parameters

- channel_1:

    This is a channel of bunch of other parameters

- channel_2:

    This is a channel of bunch of other parameters

- channel_3:

    This is a channel of bunch of other parameters

- channel_4:

    This is a channel of bunch of other parameters

- channel_5:

    This is a channel of bunch of other parameters

- channel_6:

    This is a channel of bunch of other parameters

- channel_7:

    This is a channel of bunch of other parameters

- channel_8:

    This is a channel of bunch of other parameters

- channel_9:

    This is a channel of bunch of other parameters

- semiRawValue:

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

- epsSemiRaw:

    Epsilon of the SemiRawValue.

- timeServerId:

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

- Logger:

    Logging settings

- sendCommand:

    Send command to the instrument.

- replyToCommand:

    Reply to the command send to the instrument.

- gotoErrorOnPollFailure:

    Instrument will go to error if poll fails for all properties.

- autoConnect:

    Set True to automatically connect to device.

- pollingInterval:

    The interval for polling the instrument.

- enableHeartbeat:

    Enable Heartbeat

- heartbeatCommand:

    Text to send as heartbeat

- heartbeatReply:

    Heartbeat reply text

- heartbeatPeriod:

    Heartbeat period

- heartbeatTime:

    Last heartbeat time

- pollingTimeTaken:

    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time

- pollNow:

    Poll instrument now!

- _connect_:

    Connects to the device

- disconnect:

    Disconnects from the device

- handshake:

    Set the state of the message roundtrip handshaking.

- baudRate:

    Set the transmit and receive baud rates on the RS-232 port.

- errorCount:

    The number of error records in the queue.

- measureType:

    Set the meter measurement mode (energy or power).

- statisticsMode:

    Set the statistics processing mode (on or off).

- variableDecimation:

    Set the pulse decimation rate (1-99999).

- apertureDiameter:

    Set the aperture diameter.

- wavelength:

    Set the current wavelength.

- gainCompensation:

    Enables or disables the gain compensation.

- gainFactor:

    Set the gain compensation factor.

- range:

    Set the measurement range (maximum expected measurement).

- batchSize:

    Set the statistics batch size.

- restartMode:

    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).

- statStart:

    Terminates the current statistical batch and start a new one.

- statStop:

    Terminates the current statistical batch.

- triggerSource:

    Selects the trigger source (INTernal / EXTernal).

- triggerLevel:

    Set the trigger level (no effect when external trigger is selected).

- triggerSlope:

    Selects the external trigger edge (POSitive / NEGative).

- sequenceId:

    Set the sequence ID.

- triggerBus:

    Selects the trigger bus participation mode.

- itemSelect:

    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.

- statItemSelect:

    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.

- serialNumber:

    The serial number string.

- partNumber:

    The part number.

- modelName:

    The Model Name.

- calibrationDate:

    The calibration date.

- manifacturingDate:

    The manifacturing date.

- defaultWavelength:

    The default wavelength.

- measurementRefreshRate:

    The refresh rate of measurements.

- measurement:

    Last measurement.

- idType:

    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).

- cameraId:

    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.

- packetDelay:

    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

- autoPacketSize:

    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).

- packetSize:

    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.

- exposureTime:

    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.

- triggerMode:

    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.

- triggerActivation:

    This enumeration sets the signal transition needed to activate the selected trigger.

- autoGain:

    Configures automatic gain feature.

- gain:

    Sets the gain of the ADC converter.

- acquisitionMode:

    This property sets the image acquisition mode.

- frameCount:

    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.

- xPeak1:

    x-position of peak in first calibration image.

- xFWHM1:

    x-FWHM in first calibration image.

- xPeak2:

    x-position of peak in second calibration image.

- xFWHM2:

    x-FWHM in second calibration image.

- delayUnit:

    Unit of the delay between calibration images.

- useAsCalibrationImage1:

    Use the current image as 1st calibration image.

- useAsCalibrationImage2:

    Use the current image as 2nd calibration image.

- calibrate:

  > perform calibrationStepsNumber steps of calibrationStep size starting and ending in symmetrical places relatively to initial position, both along X and Y, while measuring center of beam position.

  > Use these measurements to calculate axCoef and ayCoef.

  > Assumptions that are made: sin(x) ~= x x(y) axis of TEM parallel to x (y) axis of camera

- calibrationFactor:

    The calibration constant.

- beamShape:

    Time shape of the beam.

- xMinFit:

    Lower limit for the fit.

- xMaxFit:

    Upper limit for the fit.

- fitStatus:

    Error of fit procedure: 1-3 means good fit. See device documentation for further details.

- subtractPedestal:

    Subtract the pedestal, calculated from linear interpolation between first and last point.

- xPeak3:

    x-position of peak in the input image.

- xFWHM3:

    x-FWHM in the input image.

- pulseWidth:

    Duration of the pulse.

- ePulseWidth:

    Uncertainty of the pulse duration arising from fit procedure.

- switchToReady:

    Instructs the amplifier to go to ready state.

- switchOn:

    Instructs the amplifier to go to on state.

- switchOff:

    Instructs the amplifier to go to off state.

- closeShutter2:

    Instructs the amplifier to close Shutter 2.

- openShutter2:

    Instructs the amplifier to open Shutter 2.

- amphosIp:

    The IP address of the Amphos Control.

- amphosPort:

    The port of the Amphos Control.

- stateChanging:

    Laser is currently changing state.

- targetPower:

    Target laser power.

- chillerTemperature:

    Measured temperature of chiller.

- chillerFlow:

    Measured flow of chiller [l/min].

- chillerValvePosition:

    Measured valve position.

- shutter2IsOpen:

    Shutter2 State: False=closed True=open

- lambdaIsBusy:

    Lambda plate is moving.

- laserCurrent:

    Measured current of Amphos400.

- laserTemperature:

    Measured temperature of Amphos400.

- laserHumidity:

    Measured humidity of Amphos400.

- xfelCurrentCW1:

    Measured current of XFEL booster 1 (CW1).

- xfelCurrentCW2:

    Measured current of XFEL booster 1 (CW2).

- xfelCurrentQCW1:

    Measured current of XFEL booster 1 (QCW1).

- xfelCurrentQCW2:

    Measured current of XFEL booster 1 (QCW2).

- xfelCurrentQCW3:

    Measured current of XFEL booster 1 (QCW3).

- xfelCurrentQCW4:

    Measured current of XFEL booster 1 (QCW3).

- xfelTemperature:

    Measured temperature of XFEL booster 1.

- xfelHumidity:

    Measured humidity of XFEL booster 1.

- globalAlarmCondition:

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

- lockedBy:

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

- slotClearLock:

    Clear the lock on this device

- log:

    Logging settings

- adc:

    fast ADC input device

- selectedAdcChannel:

    fast ADC channel in use for the loop

- maxPeakValue:

    Max absolute value for ADC peak. When peak is above this value step is applied

- tuneStage:

    motor controlling the stage to adjust laser path

- stageStep:

    value of stage tuning step size

- loopPeriod:

    Time interval for feedback cycle

- doublecheckWaitTime:

    after peak is above max, this time is waiting to check itagain, before applying step

- calibStepSize:

    Size of calibration step

- calibStepNum:

    Number of calibration steps

- calibAverageNum:

    number of peak values to be averaged for each calibration step

- reverseDirection:

    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)

- conversionFactor:

    micrometers to femtoseconds conversion factor

- adcValueTimeout:

    if ADC value is not updated within this time, device goesin error state

- amphosAmpli:

    Karabo ID of Amphos Laser Amplifier

- triggerDelayDevice:

    Karabo ID of pplDelayControl device, used to read Pockels cell status

- moveToPlus:

    Move to +x position

- moveToMinus:

    Move to -x position

- moveToZero:

    Move to 0 position

- pathToProgramFiles:

    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)

- correctionFile:

    The correction (.ct5) file, including path.

- useExternalTrigger:

    Use external trigger (if true) or auto-run (if false).

- startFromMinusX:

    Set loop initial position to -X

- jumpSpeed:

    The up/down jump speed [bits/ms].

- jumpAmplitude:

    The up/down jump amplitude [bits].

- delayTimePlus:

    Delay time, after moving to position +x.

- delayTimeMinus:

    Delay time, after moving to position -x.

- onTargetTolerance:

    The tolerance [bits] when checking that Galvo is on target position.

- onTargetPlus:

    Galvo is currently at +x position _and_ not moving.

- onTargetMinus:

    Galvo is currently at -x position _and_ not moving.

- laserOn:

    The value of the LASERON signal.

- digitalOut1:

    The value of the DIGITAL OUT1 signal.

- stopEventCode:

    Stop event code.

- galvoTemperature:

    Galvanometer scanner temperature.

- servoTemperature:

    Servo board temperature.

- agcVoltage:

    AGC voltage (PD supply voltage).

- dspCoreVoltage:

    DSP core supply voltage (1.8 V).

- dspIoVoltage:

    DSP IO voltage (3.3 V).

- analogSectVoltage:

    Analog section voltage (9 V).

- adConverterVoltage:

    AD converter supply voltage (5 V).

- galvoHeatingOut:

    Relative heating output of the corresponding galvanometer scanner heater.

- beamline:

    Beamline where to operate

- timingDevice:

    Device ID of PPL Delay Control Device

- galvoDevice:

    id of Galvo Controller

- downstreamSpectr1Device:

    Spectrometer 1 (FXE/SCS)

- upstreamSpectr1Device:

    Spectrometer 1 (SPB/SQS)

- currentExperiment:

    Current MASTER experiment (UPSTREAM or DOWNSTREAM)

- currentVersion:

    Current version

- correctionFactorMaster:

    Correction Factor Master

- correctionFactorSlave:

    Correction Factor Slave

- switchProgress:

    Switching Progress

- switchExperiment:

    Procedure to automatically swap between FXE and SPB delay control and Galvo settings

- on:

    Instructs the device to switch on

- off:

    Instructs device to switch off

- lastError:

    Last error message received. Time is set by front-end firmware.

- scpiTimeout:

    The SCPI communication timeout.

- baseFreq:

    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)

- frontendReset:

    send reset command

- s7ack:

    acknowledge to s7 command

- s8ack:

    acknowledge to s8 command

- s9ack:

    acknowledge to s9 command

- laserEmission:

    True when laser ON, false when OFF

- generalStatus:

    True = OK, False = not OK

- temperatureStatus:

    True = OK, False = not OK

- delayBoardStatus:

    True = OK, False = not OK

- inputPin0Status:

    True = OK, False = not OK

- inputPin4Status:

    True = OK, False = not OK

- pd1Voltage:

    Photodiode 1 (TAB 2) voltage

- pd1VoltageAverage:

    Averaged PD1 (TAB 2) voltage

- pd2Voltage:

    Photodiode 2 (TAB 5) voltage

- pd2VoltageAverage:

    Averaged PD2 (TAB 5) voltage

- pd3Voltage:

    PD3 (SPCO 1) voltage

- pd3VoltageAverage:

    Averaged PD3 (SPCO 1) voltage

- pd4Voltage:

    PD4 (TAB 7) voltage

- pd4VoltageAverage:

    Averaged PD4 (TAB 7) voltage

- pd5Voltage:

    PD5 (SPCO2) voltage

- pd5VoltageAverage:

    Averaged PD5 (SPCO2) voltage

- pd6Voltage:

    PD6 voltage

- pd6VoltageAverage:

    Averaged PD6 voltage

- pd7Voltage:

    PD7 voltage

- pd7VoltageAverage:

    Averaged PD7 voltage

- pd8Voltage:

    PD8 voltage

- pd8VoltageAverage:

    Averaged PD8 voltage

- seederOutPower:

    photodiode 1

- xf1OutPower:

    Photodiode 7

- xf2OutPower:

    Photodiode 8

- seederStatus:

    True = OK, False = not OK

- generalSeederStatus:

    True = OK, False = not OK

- hiltiErrorStatus:

    True = OK, False = not OK

- remoteControl:

    if it is false we cannot see it

- regOnOff0:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- regOnOff1:

    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.

- setpAX0:

    Variable SetpAx[0] define the setpoint of the servo loop.

- setpAY0:

    Variable SetpAy[0] define the setpoint of the servo loop.

- sumA0:

    Sum signal of angle detector ‘A’

- sumB0:

    Sum signal of position detector ‘B’

- aX0:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY0:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX0:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY0:

    Variable By represents the measured position deviation in y direction from zero position

- rAX0:

    Regulator Output Ax

- rAY0:

    Regulator Output Ay

- rBX0:

    Regulator Output Bx

- rBY0:

    Regulator Output By

- rAXM0:

    Regulator Output AxM

- rAYM0:

    Regulator Output AyM

- rBXM0:

    Regulator Output BxM

- rBYM0:

    Regulator Output ByM

- setpAX1:

    Variable SetpAx[1] define the setpoint of the servo loop.

- setpAY1:

    Variable SetpAy[1] define the setpoint of the servo loop.

- sumA1:

    Sum signal of angle detector ‘A’

- sumB1:

    Sum signal of position detector ‘B’

- aX1:

    Variable Ax represents the measured angle deviation in x direction from zero position

- aY1:

    Variable Ay represents the measured angle deviation in y direction from zero position

- bX1:

    Variable Bx represents the measured position deviation in x direction from zero position

- bY1:

    Variable By represents the measured position deviation in y direction from zero position

- rAX1:

    Regulator Output Ax

- rAY1:

    Regulator Output Ay

- rBX1:

    Regulator Output Bx

- rBY1:

    Regulator Output By

- rAXM1:

    Regulator Output AxM

- rAYM1:

    Regulator Output AyM

- rBXM1:

    Regulator Output BxM

- rBYM1:

    Regulator Output ByM

- stage1Id:

    Karabo device ID of first grating motor

- stage2Id:

    Karabo device ID of first grating motor

- tunnel:

    Location where doocs_device is deployed (e.g. ‘SASE1’)

- labx2MName:

    DOOCS name of X2 Master doocs_device

- labx2SName:

    DOOCS name of X2 Slave doocs_device

- timingShifterName:

    DOOCS name of Phase Shifter doocs_device

- manualTuning:

    Manual Tuning Enable

- useShifter:

    Set to True if optical synchronization is available

- midTsValue:

    Mid Value of Phase Shifter

- maxTsDelay:

    Maximum delay to add/subtract to phase shifter position

- maxTsJitter:

    Maximum allowed jitter

- laserOpModeList:

    Select Laser Op Mode

- activeLaserOpMode:

    Active Op laser Mode

- laserOpModeListApply:

    Apply Laser Operation Mode

- dmBCCAuto:

    Automatic loop on/off

- pCellState:

    Status of Pockels Cell, True = On

- pCellOn:

    Set Pockels cell on

- pCellOff:

    Set Pockels cell off

- AOMState:

    Status of AOM, True = On

- AOMOn:

    Set AOM on

- AOMOff:

    Set AOM off

- maxAllowedPcPhase:

    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.

- mPCCLKPhase:

    Master PC Phase

- mSWPCCLKPhase:

    Master SW PC Phase

- mBurstWidth:

    Master burst width [us]

- mBurstWidthApply:

    Apply m Burst Width

- mBurstStart:

    Begining of the bursts the slave burst is +50ms)

- mBurstStartsms:

    Master burst starts pos. [us]

- sBurstStartsms:

    Sleve burst starts pos. [us]

- smBurstDiff:

    Different between muster and slave burst positione

- sPCCLKPhase:

    Master PC Phase

- sSWPCCLKPhase:

    Slave software PC PHase

- sBurstWidth:

    Slave burst width [us]

- sBurstWidthApply:

    Apply S Burst width

- delayBPMaster:

    Current delay of the master bunch pattern in clock unit (machine)

- delayBPMasterP:

    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterM:

    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)

- delayBPMasterP24:

    Increment Master Bunch Pattern delay by 24 clock unit

- delayBPMasterM24:

    Decrement Master Bunch Pattern delay by 24 clock unit

- delayBPSlave:

    Current delay of the slave bunch pattern in clock unit (machine)

- delayBPSlaveP:

    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveM:

    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)

- delayBPSlaveP24:

    Increment Slave Bunch Pattern delay by 24 clock unit

- delayBPSlaveM24:

    Decrement Slave Bunch Pattern delay by 24 clock unit

- masterExpPattern:

    Select pattern for master experiment

- slaveExpPattern:

    Select pattern for slave experiment

- currentLaserPatterns:

    Current Laser Patterns

- currentMasterLaserPattern:

    Current Master Laser Patterns

- currentSlaveLaserPattern:

    Current Slave Laser Patterns

- currentSlaveLaserPatternN:

    Current Slave Laser Pattern

- fineDelayMaxCounts:

    Fine delay - maximum count number

- fineDelayValue:

    fine delay count value

- fineDelayValueT:

    fine delay time value

- fineDelayP:

    Increment fine delay

- fineDelayM:

    Decrement fine delay

- fineDelay9nsChange:

    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns

- fineDelay9ns:

    Change Fine Delay by 9 ns

- minTsPosition:

    Minimum Timing Shifter Delay

- maxTsPosition:

    Maximum Timing Shifter Delay

- currentTsPosition:

    current value of time shifter position

- requestedTsDelay:

    Delay to apply to the phase shifter

- DelayTsChange:

    Change phase shifter by requested value

- relAbsolutTsPos:

    True for relative, False for absolute

- stopPsChange:

    Abort phase shift change

- opticalSynch:

    Display status of optical synchronization

- opticalSynchLock:

    Display lock status of optical synchronization

- opticalSynchJitter:

    Display status of optical synchronization jitter

- opticalSynchMode:

    Optical synch. mode (RF / Optical)

- setOpticalDelay:

    Delay to apply to optical delay line

- applyOpticalDelay:

    change the optical delay by requeste value

- currentOpticalDelay:

    Current position of optical delay

- relAbsolutDelayLine:

    True for relative, False for absolute

- TsJitter:

    Optical Synchronization Jitter

- triggerFE_DOWNSTREAM:

    Current trigger delay FE DOWNSTREAM

- triggerFE_UPSTREAM:

    Current trigger delay FE UPSTREAM

- getCurrentHardwareStatus:

    Read configuration from hardware

- lastShiftDelay:

    FE delay value from the prevoius shift

- setLastShiftDelay:

    Bring the delay to position from the previus shift

- clearLock:

    In case of STATE == changing bring the state to Normal

- mPCCLKPhaseSetValue:

    Master PC CLK Phase Value

- sPCCLKPhaseSetValue:

    Slave PC CLK Phase Value

- delayBPMasterSetValue:

    Master BP delay Value

- delayBPSlaveSetValue:

    Slave BP delay Value

- resetError:

    Reset error state

- upstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for upstream instrument

- downstreamTimingDrifCompensatorId:

    Karabo ID of Timing Drift Compensator device for downstream instrument

- shiftChange:

    Swaps MASTER and SLAVE properties between upstream and downstream instrument

- isOxcActive:

    Status of optical lock (True: OPTICAL mode, False: RF mode)

- requestedDelay:

    Relative delay to be applied by delay change (Trigger Position)

- delayChange:

    Change delay value by applying (relative) offset

- mPCCLKPhaseP:

    Increment PC master Phase

- mPCCLKPhaseM:

    Decrement PC master Phase

- sPCCLKPhaseP:

    Increment slave PC Phase

- sPCCLKPhaseM:

    Decrement slave PC phase

- savemSWPCCLKPhase:

    Save new software phase value for PCm

- savesSWPCCLKPhase:

    Save new software phase value for PCs

- mBurstStartApply:

    Apply Burst Start Pos

- takemidTsValue:

    Take mid value of phase shifter

- logBoardsStatus:

    JSON string describing master and slave board settings.Usually updated when user actions are taken

- logFineDelay:

    JSON string describing fine delay settings.Usually updated when user actions are taken

- imgprocDevice:

    Device ID of image processor used for feedback

- temDevice:

    id of tem device

- temChannel:

    TEM channel to be controlled

- xCoefWeight:

    weight of X coefficient

- yCoefWeight:

    weight of Y coefficient

- axCoefOld:

    Value of Ax Coefficient saved prior to calibration

- ayCoefOld:

    Value of Ay Coefficient saved prior to calibration

- xBeamCenterTarget:

    desired value for Beam Center X coordinate

- yBeamCenterTarget:

    desired value for Beam Center Y coordinate

- beamCenterMaxDisplacement:

    maximum allowed displacement for Center of Mass from target position

- maxTemDrift:

    Maximum value allowed for TEM drift

- averageNumber:

    number of values of beam center coordinates to average

- timeoutImageProcessorValues:

    Time to wait before going in error when values from image processor are not updating

- imageSettlementTime:

    Time to wait before reading beam center coordinates aftermoving TEM setpoint

- calibrationStep:

    TEM setpoint step size for calibration

- calibrationStepsNumber:

    Number of TEM calibration steps

- maxTimeNotRegulating:

    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.

- setCurrentPosAsTarget:

    Set current beam position as target

- pwmFrequency:

- pwmDutyCycle:

- pwmCycleLimit:

    Number Of PWM Cycles, 0 = inifite number of cycles

- enableLatchInternal:

    Enables the storage of the value of the scale latched to the internal reference

- enableLatchExternal:

    Enables the storage of the value of the scale latched to the external reference

- adcValue:

    The integer value read out by the encoder

- factor:

    Calibration factor to target unit

- setCounter16:

    Set value for 16 bit encoder.

- setCounter32:

    Set value for 32 bit encoder.

- ssiCoding:

    Binary coding or grey coding. False - Binary; True - Grey

- ssiFrameType:

    Length of the SSI data frame.

- ssiFrameSize:

    Not documented.

- ssiDataLength:

    Not documented.

- cppServerId:

    The cppServer where the beckhoffCom is running on

- beckhoffId:

    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.

- blacklist:

    These devices won’t be instantiated etc.

- groups:

    The available component groups

- components:

    The available components

- instantiateWait:

    The deviceId of beckhoffCom to monitor

- availableScenes:

    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

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

###### CAM_WATCHDOG

###### CHILLER_MONITOR

###### PPL_INFOS_FXE

###### PPL_INFOS_SPB

###### USER_STARTER

##### MOTOR

[add component documentation]

###### CYLLENS_FXE_FA

Instance id: | LA1_LAS_PPL/MOTOR/CYLLENS_FXE_FA
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### CYLLENS_FXE_SA

Instance id: | LA1_LAS_PPL/MOTOR/CYLLENS_FXE_SA
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### CYLLENS_SPB_FA

Instance id: | LA1_LAS_PPL/MOTOR/CYLLENS_SPB_FA
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### CYLLENS_SPB_SA

Instance id: | LA1_LAS_PPL/MOTOR/CYLLENS_SPB_SA
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### LINSTAGE_SPARE_3

Instance id: | LA1_LAS_PPL/MOTOR/LINSTAGE_SPARE_3
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### LINSTAGE_SPARE_4

Instance id: | LA1_LAS_PPL/MOTOR/LINSTAGE_SPARE_4
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### MIRROUT1H_NOPA_FXE

Instance id: | LA1_LAS_PPL/MOTOR/MIRROUT1H_NOPA_FXE
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### MIRROUT1H_NOPA_SPB

Instance id: | LA1_LAS_PPL/MOTOR/MIRROUT1H_NOPA_SPB
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### MIRROUT1H_UNCOMP_FXE

Instance id: | LA1_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_FXE
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### MIRROUT1H_UNCOMP_SPB

Instance id: | LA1_LAS_PPL/MOTOR/MIRROUT1H_UNCOMP_SPB
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### MIRROUT1V_NOPA_FXE

Instance id: | LA1_LAS_PPL/MOTOR/MIRROUT1V_NOPA_FXE
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### MIRROUT1V_NOPA_SPB

Instance id: | LA1_LAS_PPL/MOTOR/MIRROUT1V_NOPA_SPB
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### MIRROUT1V_UNCOMP_FXE

Instance id: | LA1_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_FXE
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### MIRROUT1V_UNCOMP_SPB

Instance id: | LA1_LAS_PPL/MOTOR/MIRROUT1V_UNCOMP_SPB
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### MIRROUT2H_NOPA_FXE

Instance id: | LA1_LAS_PPL/MOTOR/MIRROUT2H_NOPA_FXE
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### MIRROUT2H_NOPA_SPB

Instance id: | LA1_LAS_PPL/MOTOR/MIRROUT2H_NOPA_SPB
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### MIRROUT2H_UNCOMP_FXE

Instance id: | LA1_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_FXE
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### MIRROUT2H_UNCOMP_SPB

Instance id: | LA1_LAS_PPL/MOTOR/MIRROUT2H_UNCOMP_SPB
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### MIRROUT2V_NOPA_FXE

Instance id: | LA1_LAS_PPL/MOTOR/MIRROUT2V_NOPA_FXE
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### MIRROUT2V_NOPA_SPB

Instance id: | LA1_LAS_PPL/MOTOR/MIRROUT2V_NOPA_SPB
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### MIRROUT2V_UNCOMP_FXE

Instance id: | LA1_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_FXE
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### MIRROUT2V_UNCOMP_SPB

Instance id: | LA1_LAS_PPL/MOTOR/MIRROUT2V_UNCOMP_SPB
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### ROT_SPARE_3

Instance id: | LA1_LAS_PPL/MOTOR/ROT_SPARE_3
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### ROT_SPARE_4

Instance id: | LA1_LAS_PPL/MOTOR/ROT_SPARE_4
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### SPECTUNE_NOPA_FXE

Instance id: | LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_FXE
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### SPECTUNE_NOPA_SPB

Instance id: | LA1_LAS_PPL/MOTOR/SPECTUNE_NOPA_SPB
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### WP_DIAG_FXE

Instance id: | LA1_LAS_PPL/MOTOR/WP_DIAG_FXE
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### WP_DIAG_SPB

Instance id: | LA1_LAS_PPL/MOTOR/WP_DIAG_SPB
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### WP_FXE_1

Instance id: | LA1_LAS_PPL/MOTOR/WP_FXE_1
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### WP_FXE_2

Instance id: | LA1_LAS_PPL/MOTOR/WP_FXE_2
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### WP_FXE_CR_1

Instance id: | LA1_LAS_PPL/MOTOR/WP_FXE_CR_1
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### WP_FXE_CR_2

Instance id: | LA1_LAS_PPL/MOTOR/WP_FXE_CR_2
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### WP_FXE_CR_3

Instance id: | LA1_LAS_PPL/MOTOR/WP_FXE_CR_3
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### WP_NOPA_FXE_1

Instance id: | LA1_LAS_PPL/MOTOR/WP_NOPA_FXE_1
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### WP_NOPA_FXE_2

Instance id: | LA1_LAS_PPL/MOTOR/WP_NOPA_FXE_2
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### WP_NOPA_FXE_3

Instance id: | LA1_LAS_PPL/MOTOR/WP_NOPA_FXE_3
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### WP_NOPA_SPB_1

Instance id: | LA1_LAS_PPL/MOTOR/WP_NOPA_SPB_1
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### WP_NOPA_SPB_2

Instance id: | LA1_LAS_PPL/MOTOR/WP_NOPA_SPB_2
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### WP_NOPA_SPB_3

Instance id: | LA1_LAS_PPL/MOTOR/WP_NOPA_SPB_3
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### WP_SPB_1

Instance id: | LA1_LAS_PPL/MOTOR/WP_SPB_1
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### WP_SPB_2

Instance id: | LA1_LAS_PPL/MOTOR/WP_SPB_2
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### WP_SPB_CR_1

Instance id: | LA1_LAS_PPL/MOTOR/WP_SPB_CR_1
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### WP_SPB_CR_2

Instance id: | LA1_LAS_PPL/MOTOR/WP_SPB_CR_2
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

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

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

###### WP_SPB_CR_3

Instance id: | LA1_LAS_PPL/MOTOR/WP_SPB_CR_3
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

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

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

Release History
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

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

###### WP_TEM

Instance id: | LA1_LAS_PPL/MOTOR/WP_TEM
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    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
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.

Release History
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

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

##### PLC

[add component documentation]

###### COM

Instance id: | LA1_LAS_PPL/PLC/COM
Host: | exflcon14n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether the devices instantiated, will have interlock conditions settable.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the Karabo device in case of an error
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations

Release History
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

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

###### COM_PLCMON

Instance id: | LA1_LAS_PPL/PLC/COM_PLCMON
Host: | exflcon14n0
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
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

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

##### PMOTOR

[add component documentation]

###### CMCOMPSTAGE

Instance id: | LA1_LAS_PPL/PMOTOR/CMCOMPSTAGE
Class id: | BeckhoffSimpleMotor
Host: | spb-rr-sys-con-camopt
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-camopt
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
Scenes: | PPL_BCCs
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Installation not found in a standard path!

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

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- 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.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

###### DMCOMPSTAGE

Instance id: | LA1_LAS_PPL/PMOTOR/DMCOMPSTAGE
Class id: | BeckhoffSimpleMotor
Host: | spb-rr-sys-con-camopt
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-camopt
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
Scenes: | PPL_BCCs
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Installation not found in a standard path!

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

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- 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.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

###### NANOSSPARE1

Instance id: | LA1_LAS_PPL/PMOTOR/NANOSSPARE1
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
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

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

###### TRACEYCOMP_FXE_1

Instance id: | LA1_LAS_PPL/PMOTOR/TRACEYCOMP_FXE_1
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
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

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

###### TRACEYCOMP_FXE_2

Instance id: | LA1_LAS_PPL/PMOTOR/TRACEYCOMP_FXE_2
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
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

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

###### TRACEYCOMP_SPB_1

Instance id: | LA1_LAS_PPL/PMOTOR/TRACEYCOMP_SPB_1
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
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

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

###### TRACEYCOMP_SPB_2

Instance id: | LA1_LAS_PPL/PMOTOR/TRACEYCOMP_SPB_2
Host: | exflcon14n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error state
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time

Release History
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

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

##### PROC

[add component documentation]

###### AC_FXE_DIAG

Instance id: | LA1_LAS_PPL/PROC/AC_FXE_DIAG
Host: | exflcon70n0
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-2 , la1-gui2 , la1-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### AC_SPB_DIAG

Instance id: | LA1_LAS_PPL/PROC/AC_SPB_DIAG
Host: | exflcon70n0
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-2 , la1-gui2 , la1-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### AMPHOS_FF

Instance id: | LA1_LAS_PPL/PROC/AMPHOS_FF
Host: | exflcon205
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### AMPHOS_INPUT_NF

Instance id: | LA1_LAS_PPL/PROC/AMPHOS_INPUT_NF
Host: | exflcon205
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### AMPHOS_NF

Instance id: | LA1_LAS_PPL/PROC/AMPHOS_NF
Host: | exflcon205
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### FE_XF1_FF

Instance id: | LA1_LAS_PPL/PROC/FE_XF1_FF
Host: | exflcon205
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### FE_XF1_NF

Instance id: | LA1_LAS_PPL/PROC/FE_XF1_NF
Host: | exflcon205
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### FE_XF2_NF

Instance id: | LA1_LAS_PPL/PROC/FE_XF2_NF
Host: | exflcon205
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### FF_CAM_TEM

Instance id: | LA1_LAS_PPL/PROC/FF_CAM_TEM
Host: | exflcon205
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### FXE_Instr_1

Instance id: | LA1_LAS_PPL/PROC/FXE_Instr_1
Host: | exflcon70n0
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-2 , la1-gui2 , la1-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### FXE_Instr_2

Instance id: | LA1_LAS_PPL/PROC/FXE_Instr_2
Host: | exflcon70n0
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-2 , la1-gui2 , la1-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### FXE_SEED

Instance id: | LA1_LAS_PPL/PROC/FXE_SEED
Host: | exflcon70n0
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-2 , la1-gui2 , la1-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### FXE_UNCOMP

Instance id: | LA1_LAS_PPL/PROC/FXE_UNCOMP
Host: | exflcon70n0
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-2 , la1-gui2 , la1-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### GALVO_FXE

Instance id: | LA1_LAS_PPL/PROC/GALVO_FXE
Host: | exflcon70n0
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-2 , la1-gui2 , la1-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### GALVO_SPB

Instance id: | LA1_LAS_PPL/PROC/GALVO_SPB
Host: | exflcon70n0
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-2 , la1-gui2 , la1-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### NOPA_FXE_1

Instance id: | LA1_LAS_PPL/PROC/NOPA_FXE_1
Host: | exflcon70n0
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-2 , la1-gui2 , la1-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### NOPA_FXE_2

Instance id: | LA1_LAS_PPL/PROC/NOPA_FXE_2
Host: | exflcon70n0
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-2 , la1-gui2 , la1-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### NOPA_FXE_3

Instance id: | LA1_LAS_PPL/PROC/NOPA_FXE_3
Host: | exflcon70n0
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-2 , la1-gui2 , la1-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### NOPA_FXE_SEED

Instance id: | LA1_LAS_PPL/PROC/NOPA_FXE_SEED
Host: | exflcon70n0
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-2 , la1-gui2 , la1-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 peak position from 1D fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 peak position from 1D fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 peak position from 2D fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 peak position from 2D fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### NOPA_SPB_1

Instance id: | LA1_LAS_PPL/PROC/NOPA_SPB_1
Host: | exflcon70n0
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-2 , la1-gui2 , la1-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### NOPA_SPB_2

Instance id: | LA1_LAS_PPL/PROC/NOPA_SPB_2
Host: | exflcon70n0
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-2 , la1-gui2 , la1-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### SPB_Instr_1

Instance id: | LA1_LAS_PPL/PROC/SPB_Instr_1
Host: | exflcon70n0
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-2 , la1-gui2 , la1-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### SPB_Instr_2

Instance id: | LA1_LAS_PPL/PROC/SPB_Instr_2
Host: | exflcon70n0
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-2 , la1-gui2 , la1-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### SPB_Instr_3

Instance id: | LA1_LAS_PPL/PROC/SPB_Instr_3
Host: | exflcon70n0
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-2 , la1-gui2 , la1-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### SPB_SEED

Instance id: | LA1_LAS_PPL/PROC/SPB_SEED
Host: | exflcon70n0
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-2 , la1-gui2 , la1-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### SPB_UNCOMP

Instance id: | LA1_LAS_PPL/PROC/SPB_UNCOMP
Host: | exflcon70n0
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-2 , la1-gui2 , la1-rr-sys-con-gui2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### XF1FE_DIAG_PROC

Instance id: | LA1_LAS_PPL/PROC/XF1FE_DIAG_PROC
Host: | exflcon205
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 peak position from 1D fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 peak position from 1D fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 peak position from 2D fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 peak position from 2D fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

###### XF1_DIAG_SPB_TEM

Instance id: | LA1_LAS_PPL/PROC/XF1_DIAG_SPB_TEM
Host: | exflcon205
Class documentation:
| ImageProcessor
Alias: | la1-rr-ppl-con-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-03-17T11:23:32.000+01:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Giovanetti
Latest tag: | 1.27.1-2.8.0
Deployment tag: | 1.27.1-2.8.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    The connection to the communication layer of the distributed system
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the processor output values.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Switch motor current On.
- off:
    Switch motor current Off.
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

1.16.1-2.3.4

Created: | 2019-02-12T09:02:33.000Z
Author: | Andrea Parenti
Notes: | Only log first 5 errors in TwoPeakFinder Remove obsolete DaqCompliancy dependency

1.16.0-2.3.4

Created: | 2019-02-01T15:13:24.000Z
Author: | Cyril Danilevski
Notes: | Add twin peak finder

1.15.0-2.3.2

Created: | 2019-01-31T10:18:10.000Z
Author: | Andrea Parenti
Notes: | ADD interfaces to all devices FIX ImageToSpectrum and ImageNormRoi for K2.3 FIX states for K2.3 - now ON/PROCESSING

##### PUMP

[add component documentation]

###### PUMP_BEAMPIPES_ON_OFF

Instance id: | LA1_LAS_PPL/PUMP/PUMP_BEAMPIPES_ON_OFF
Host: | exflcon14n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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
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

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

###### PUMP_BEAMPIPES_STATUS

Instance id: | LA1_LAS_PPL/PUMP/PUMP_BEAMPIPES_STATUS
Host: | exflcon14n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs the device to switch on and stopped.
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The serial number string.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    This enumeration enables or disables the trigger. When this is set to ‘On’, the target frame rate parameter will be ignored.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay with respect to T0 master trigger.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 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.
- 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.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

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

##### SPECPROC

[add component documentation]

###### NOPA_FXE_1

###### NOPA_FXE_2

###### NOPA_FXE_3

###### NOPA_SPB_1

###### NOPA_SPB_2

###### NOPA_SPB_3

###### SEEDER_SPECTROMETER

##### SPECT

[add component documentation]

###### NOPA_FXE_1

###### NOPA_FXE_2

###### NOPA_SPB_1

###### NOPA_SPB_2

###### NOPA_SPB_3

###### SEEDER_SPECTROMETER

##### SWITCH

[add component documentation]

###### LABCHL_ALARM_COLLECTIVE

Instance id: | LA1_LAS_PPL/SWITCH/LABCHL_ALARM_COLLECTIVE
Host: | exflcon14n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### LABCHL_ALARM_FLOW_1

Instance id: | LA1_LAS_PPL/SWITCH/LABCHL_ALARM_FLOW_1
Host: | exflcon14n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### LABCHL_ALARM_GUIDE_VALUE

Instance id: | LA1_LAS_PPL/SWITCH/LABCHL_ALARM_GUIDE_VALUE
Host: | exflcon14n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### LABCHL_ALARM_PRESSURE

Instance id: | LA1_LAS_PPL/SWITCH/LABCHL_ALARM_PRESSURE
Host: | exflcon14n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### LABCHL_ALARM_TEMPERATURE

Instance id: | LA1_LAS_PPL/SWITCH/LABCHL_ALARM_TEMPERATURE
Host: | exflcon14n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### LABCHL_ALARM_WATERLEVEL

Instance id: | LA1_LAS_PPL/SWITCH/LABCHL_ALARM_WATERLEVEL
Host: | exflcon14n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

##### TSENS

[add component documentation]

###### TEMPERATURE

Instance id: | LA1_LAS_PPL/TSENS/TEMPERATURE
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### TEMP_EQUIP_1

Instance id: | LA1_LAS_PPL/TSENS/TEMP_EQUIP_1
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### TEMP_EQUIP_2

Instance id: | LA1_LAS_PPL/TSENS/TEMP_EQUIP_2
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### TEMP_EQUIP_3

Instance id: | LA1_LAS_PPL/TSENS/TEMP_EQUIP_3
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### TEMP_EQUIP_4

Instance id: | LA1_LAS_PPL/TSENS/TEMP_EQUIP_4
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### TEMP_EQUIP_5

Instance id: | LA1_LAS_PPL/TSENS/TEMP_EQUIP_5
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### TEMP_EQUIP_6

Instance id: | LA1_LAS_PPL/TSENS/TEMP_EQUIP_6
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### TEMP_EQUIP_7

Instance id: | LA1_LAS_PPL/TSENS/TEMP_EQUIP_7
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### TEMP_EQUIP_8

Instance id: | LA1_LAS_PPL/TSENS/TEMP_EQUIP_8
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### TEMP_TABLE_1

Instance id: | LA1_LAS_PPL/TSENS/TEMP_TABLE_1
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### TEMP_TABLE_2

Instance id: | LA1_LAS_PPL/TSENS/TEMP_TABLE_2
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### TEMP_TABLE_3

Instance id: | LA1_LAS_PPL/TSENS/TEMP_TABLE_3
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### TEMP_TABLE_4

Instance id: | LA1_LAS_PPL/TSENS/TEMP_TABLE_4
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### TEMP_TABLE_5

Instance id: | LA1_LAS_PPL/TSENS/TEMP_TABLE_5
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### TEMP_TABLE_6

Instance id: | LA1_LAS_PPL/TSENS/TEMP_TABLE_6
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### TEMP_TABLE_7

Instance id: | LA1_LAS_PPL/TSENS/TEMP_TABLE_7
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

###### TEMP_TABLE_8

Instance id: | LA1_LAS_PPL/TSENS/TEMP_TABLE_8
Host: | exflcon14n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up

Release History
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

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

##### TSYS

[add component documentation]

###### TIMESERVER

Instance id: | LA1_LAS_PPL/TSYS/TIMESERVER
Host: | la1-las-sys-utc-1
Class documentation:
| TimeServer
Alias: | la1-las-sys-utc-1-mch , la1-las-ppl-utca-1-cpu , sa1-las-ppl-utca-1-cpu
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/timeServer
Last modified: | 2020-06-22T14:36:13.000+02:00
Created at: | 2016-12-02T14:04:29.000+01:00
Main authors: | Fabbri, Parenti, Hauf
Latest tag: | 2.7.0-2.9.0
Deployment tag: | 2.7.0-2.9.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the device in case of an error
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Instructs device to go to started state
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Autogenerated scenes for the device.
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Target position in position mode.
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up
- tickFactor:
    The number defining which tick should be broadcasted. Example: 10 means “every tenth tick”
- 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)
- 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.7.0-2.9.0

Created: | 2020-05-27T13:47:21.000Z
Author: | Steffen Hauf
Notes: |

2.7.0-2.9

Created: | 2020-05-27T13:47:21.000Z
Author: | Steffen Hauf
Notes: | Bunch patterns as digests, add a BunchPatternStats device

2.6.0-2.7

Created: | 2020-02-12T14:34:09.000Z
Author: | Gero Flucke
Notes: | Introduce average difference of id increase and add alarms to it

2.5.3-2.4.0

Created: | 2019-05-07T14:35:38.000Z
Author: | Alessandro Silenzi
Notes: | Avoid System Crashes on multiple instances

2.5.2-2.3.3

Created: | 2019-01-23T09:01:43.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: avoid namespace collision with pcLayer

2.5.1-2.3.0

Created: | 2018-12-10T13:26:22.000Z
Author: | Alessandro Silenzi
Notes: | added DAQ Policy

2.5.0-2.2.6

Created: | 2018-11-29T15:54:33.000Z
Author: | Alessandro Silenzi
Notes: | Added read Bunch Pattern table feature

2.4.0-2.1.15

Created: | 2018-02-27T10:18:55.000Z
Author: | Gero Flucke
Notes: | Publish signalled trainIds to data logger

2.3.2-2.1.15

Created: | 2017-09-14T13:41:19.000Z
Author: | Sergey Esenov
Notes: | Fix SIGFPE in signalHandler

2.3.1-2.1.15

Created: | 2017-08-25T08:54:38.000Z
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-20T12:55:53.000Z
Author: | Sergey Esenov
Notes: |

2.2.0-2.1.12

Created: | 2017-06-12T13:43:27.000Z
Author: | esenov
Notes: |

2.2.0-2.1

Created: | 2017-06-12T13:43:27.000Z
Author: | esenov
Notes: | version 2.2.0

2.1.8

Created: | 2017-06-09T09:51:55.000Z
Author: | esenov
Notes: | Add optional explicit configuration of device file (_/dev/x2timers3_). It is useful if several device files are registered and you need to pick up one particular.

2.1.7

Created: | 2017-06-07T13:34:40.000Z
Author: | esenov
Notes: | The ‘tickFactor’ parameter was added.

2.1.6-LPD

Created: | 2016-12-09T09:30:28.000Z
Author: | Sergey Esenov
Notes: | tagged against karabo framework branch 2.2.0-squad2-feature-branch

2.0.0-1.4

Created: | 2016-07-20T12:38:02.000Z
Author: | abeckman
Notes: | release 2.0.0 for Karabo 1.4 (from trunk)

1.0.1-1.4

Created: | 2015-12-16T12:50:25.000Z
Author: | abeckman
Notes: | release 1.0.1 for Karabo 1.4 from trunk

1.0.1-1.3

Created: | 2015-11-17T15:03:20.000Z
Author: | abeckman
Notes: | release 1.0.1 for Karabo 1.3

1.0.1-1.2

Created: | 2015-05-11T12:50:30.000Z
Author: | abeckman
Notes: | release 1.0.1 for Karabo 1.2.6

##### VACUUM

[add component documentation]

###### CONTROL

PPL Vacuum Control

The `PplVacuumControl` device is documented in pplVacuumControl:welcome

##### VALVE

[add component documentation]

###### VALVE_FXE

Instance id: | LA1_LAS_PPL/VALVE/VALVE_FXE
Host: | exflcon14n0
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Start active monitoring of system
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Scenes from the PplPattern
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Hardware target position as read from the device
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up
- tickFactor:
    The number defining which tick should be broadcasted. Example: 10 means “every tenth tick”
- 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)
- 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.
- interValvesState:
    The current state of pipe in-between pump and valves.It is ON/OFF in case all valves are closed/open.
- loopPollTime:
    The interval in which the watchdog monitors the relevant variables.
- pumpDownTimeoutStartup:
    Soon after device startup go in error state if desired vacuum is not reached before this timeout expires.
- depressureTime:
    Go in error if pressure goes above max limit faster than this value.
- pumpSectionTime:
    Time to wait when the pump is started before opening valves
- chamberPressureUpstream:
    Gauge device to monitor the pressure in upstream laser pipe
- chamberPressureDownstream:
    Gauge device to monitor the pressure in downstream laser pipe
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- maxSwTime:
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low

Release History
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

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

###### VALVE_SPARE1

Instance id: | LA1_LAS_PPL/VALVE/VALVE_SPARE1
Host: | exflcon14n0
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Start active monitoring of system
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Scenes from the PplPattern
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Hardware target position as read from the device
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up
- tickFactor:
    The number defining which tick should be broadcasted. Example: 10 means “every tenth tick”
- 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)
- 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.
- interValvesState:
    The current state of pipe in-between pump and valves.It is ON/OFF in case all valves are closed/open.
- loopPollTime:
    The interval in which the watchdog monitors the relevant variables.
- pumpDownTimeoutStartup:
    Soon after device startup go in error state if desired vacuum is not reached before this timeout expires.
- depressureTime:
    Go in error if pressure goes above max limit faster than this value.
- pumpSectionTime:
    Time to wait when the pump is started before opening valves
- chamberPressureUpstream:
    Gauge device to monitor the pressure in upstream laser pipe
- chamberPressureDownstream:
    Gauge device to monitor the pressure in downstream laser pipe
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- maxSwTime:
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low

Release History
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

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

###### VALVE_SPARE2

Instance id: | LA1_LAS_PPL/VALVE/VALVE_SPARE2
Host: | exflcon14n0
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Start active monitoring of system
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Scenes from the PplPattern
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Hardware target position as read from the device
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up
- tickFactor:
    The number defining which tick should be broadcasted. Example: 10 means “every tenth tick”
- 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)
- 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.
- interValvesState:
    The current state of pipe in-between pump and valves.It is ON/OFF in case all valves are closed/open.
- loopPollTime:
    The interval in which the watchdog monitors the relevant variables.
- pumpDownTimeoutStartup:
    Soon after device startup go in error state if desired vacuum is not reached before this timeout expires.
- depressureTime:
    Go in error if pressure goes above max limit faster than this value.
- pumpSectionTime:
    Time to wait when the pump is started before opening valves
- chamberPressureUpstream:
    Gauge device to monitor the pressure in upstream laser pipe
- chamberPressureDownstream:
    Gauge device to monitor the pressure in downstream laser pipe
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- maxSwTime:
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low

Release History
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

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

###### VALVE_SPB

Instance id: | LA1_LAS_PPL/VALVE/VALVE_SPB
Host: | exflcon14n0
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | la1-rr-ppl-con-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-06-19T18:35:45.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Silenzi, Giovanetti, Goeries
Latest tag: | 4.3.15-2.9.1
Deployment tag: | 4.3.15-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- _serverId_:
    Do not set this property, it will be set by the device-server
- _deviceId_:
    Do not set this property, it will be set by the device-server
- _connection_:
    Do not set this property, it will be set by the device-server
- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- scale:
    Scaling factor for analog value.
- offset:
    Offset will be added to encoder position.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.
- rawValue:
    Digital input of DAC. This value is updated only on request!
- start:
    Start active monitoring of system
- stop:
    Instructs camera to stop current acquisition
- resetADC:
    Reset ADC’s of FPGA in case of constant line, No signal
- resetDDR2:
    Resets DDR2 in case of constant line, No signal
- deviceFile:
    Device driver file to access the hardware (e.g. /dev/pciedevs9).
- mapDirectory:
    Folder where all xml mapping files are located.
- numberRawSamples:
    Number of raw samples to aquire, per channel, with each start of raw data acquisition.
- delay:
    Delay between calibration images.
- skipSamples:
    If 1/2/3/…, show only every 2nd/3rd/4th/… raw ADC value (i.e. “zoom out”).
- triggerTime:
    Time between Triggers
- triggerTimeStat:
    Histogram of time between Triggers
- trainId:
    Current train ID as read from the FPGA
- config:
    Board related configuration parameters.
- dacNode:
    Set up DAC parameters
- channel_0:
    This is a channel of bunch of other parameters
- channel_1:
    This is a channel of bunch of other parameters
- channel_2:
    This is a channel of bunch of other parameters
- channel_3:
    This is a channel of bunch of other parameters
- channel_4:
    This is a channel of bunch of other parameters
- channel_5:
    This is a channel of bunch of other parameters
- channel_6:
    This is a channel of bunch of other parameters
- channel_7:
    This is a channel of bunch of other parameters
- channel_8:
    This is a channel of bunch of other parameters
- channel_9:
    This is a channel of bunch of other parameters
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- Logger:
    Logging settings
- sendCommand:
    Send command to the instrument.
- replyToCommand:
    Reply to the command send to the instrument.
- gotoErrorOnPollFailure:
    Instrument will go to error if poll fails for all properties.
- autoConnect:
    Set True to automatically connect to device.
- pollingInterval:
    The interval for polling the instrument.
- enableHeartbeat:
    Enable Heartbeat
- heartbeatCommand:
    Text to send as heartbeat
- heartbeatReply:
    Heartbeat reply text
- heartbeatPeriod:
    Heartbeat period
- heartbeatTime:
    Last heartbeat time
- pollingTimeTaken:
    Seconds required to complete commands and queries of the last polling loop excluding polling interval wait time
- pollNow:
    Poll instrument now!
- _connect_:
    Connects to the device
- disconnect:
    Disconnects from the device
- handshake:
    Set the state of the message roundtrip handshaking.
- baudRate:
    Set the transmit and receive baud rates on the RS-232 port.
- errorCount:
    The number of error records in the queue.
- measureType:
    Set the meter measurement mode (energy or power).
- statisticsMode:
    Set the statistics processing mode (on or off).
- variableDecimation:
    Set the pulse decimation rate (1-99999).
- apertureDiameter:
    Set the aperture diameter.
- wavelength:
    Set the current wavelength.
- gainCompensation:
    Enables or disables the gain compensation.
- gainFactor:
    Set the gain compensation factor.
- range:
    Set the measurement range (maximum expected measurement).
- batchSize:
    Set the statistics batch size.
- restartMode:
    Selects the action to be taken at the end of a statistical batch (MANual or AUTomatic).
- statStart:
    Terminates the current statistical batch and start a new one.
- statStop:
    Terminates the current statistical batch.
- triggerSource:
    Selects the trigger source (INTernal / EXTernal).
- triggerLevel:
    Set the trigger level (no effect when external trigger is selected).
- triggerSlope:
    Selects the external trigger edge (POSitive / NEGative).
- sequenceId:
    Set the sequence ID.
- triggerBus:
    Selects the trigger bus participation mode.
- itemSelect:
    Data items to appear in a measurement data record. Can be any combiation of: PULS,PER,FLAG,SEQ.
- statItemSelect:
    Data items to appear in a measurement data record. Can be any combination of: MEAN,MIN,MAX,STDV,DOSE,MISS,FLAG,SEQ.
- serialNumber:
    The spectrometer serial number.
- partNumber:
    The part number.
- modelName:
    The Model Name.
- calibrationDate:
    The calibration date.
- manifacturingDate:
    The manifacturing date.
- defaultWavelength:
    The default wavelength.
- measurementRefreshRate:
    The refresh rate of measurements.
- measurement:
    Last measurement.
- idType:
    The type of identifier to be used, to connect to the camera.Available options are ‘IP’ (IP address), ‘HOST’ (IP name), SN (Serial Number), MAC (MAC address).
- cameraId:
    The ‘identifier’ of the network camera. It can be an IP address (e.g. 192.168.1.153), an IP name (e.g. exflqr1234), a serial number or a MAC address (e.g. 00:30:53:25:ab:b7). The type must be specified in the ‘idType’ property.
- packetDelay:
    Configure the inter packet delay to insert between each packet for the current stream. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.
- autoPacketSize:
    Automatically determine the biggest packet size that can be used for data streaming, and set its value accordingly. If this functionality is not available, the packet size will be set to a default value (1500 bytes).
- packetSize:
    Specifies the packet size to be used by the camera for data streaming. This does not include data leader and data trailer and the last data packet which might be of smaller size.
- exposureTime:
    This float value sets the camera’s exposure time. It can only be a multiple of the minimum exposure time.
- triggerMode:
    The trigger mode: 0=normal, 1=software, 2=external synchronization, 3=external hardware.
- triggerActivation:
    This enumeration sets the signal transition needed to activate the selected trigger.
- autoGain:
    Configures automatic gain feature.
- gain:
    Sets the gain of the ADC converter.
- acquisitionMode:
    This property sets the image acquisition mode.
- frameCount:
    This value sets the number of frames acquired in the ‘Multiframe’ acquisition mode.
- xPeak1:
    x-position of peak in first calibration image.
- xFWHM1:
    x-FWHM in first calibration image.
- xPeak2:
    x-position of peak in second calibration image.
- xFWHM2:
    x-FWHM in second calibration image.
- delayUnit:
    Unit of the delay between calibration images.
- useAsCalibrationImage1:
    Use the current image as 1st calibration image.
- useAsCalibrationImage2:
    Use the current image as 2nd calibration image.
- calibrate:
    Calibrate actual position to calibrated position.
- calibrationFactor:
    The calibration constant.
- beamShape:
    Time shape of the beam.
- xMinFit:
    Lower limit for the fit.
- xMaxFit:
    Upper limit for the fit.
- fitStatus:
    Error of fit procedure: 1-3 means good fit. See device documentation for further details.
- subtractPedestal:
    Subtract the pedestal, calculated from linear interpolation between first and last point.
- xPeak3:
    x-position of peak in the input image.
- xFWHM3:
    x-FWHM in the input image.
- pulseWidth:
    Duration of the pulse.
- ePulseWidth:
    Uncertainty of the pulse duration arising from fit procedure.
- switchToReady:
    Instructs the amplifier to go to ready state.
- switchOn:
    Instructs the amplifier to go to on state.
- switchOff:
    Instructs the amplifier to go to off state.
- closeShutter2:
    Instructs the amplifier to close Shutter 2.
- openShutter2:
    Instructs the amplifier to open Shutter 2.
- amphosIp:
    The IP address of the Amphos Control.
- amphosPort:
    The port of the Amphos Control.
- stateChanging:
    Laser is currently changing state.
- targetPower:
    Target laser power.
- chillerTemperature:
    Measured temperature of chiller.
- chillerFlow:
    Measured flow of chiller [l/min].
- chillerValvePosition:
    Measured valve position.
- shutter2IsOpen:
    Shutter2 State: False=closed True=open
- lambdaIsBusy:
    Lambda plate is moving.
- laserCurrent:
    Measured current of Amphos400.
- laserTemperature:
    Measured temperature of Amphos400.
- laserHumidity:
    Measured humidity of Amphos400.
- xfelCurrentCW1:
    Measured current of XFEL booster 1 (CW1).
- xfelCurrentCW2:
    Measured current of XFEL booster 1 (CW2).
- xfelCurrentQCW1:
    Measured current of XFEL booster 1 (QCW1).
- xfelCurrentQCW2:
    Measured current of XFEL booster 1 (QCW2).
- xfelCurrentQCW3:
    Measured current of XFEL booster 1 (QCW3).
- xfelCurrentQCW4:
    Measured current of XFEL booster 1 (QCW3).
- xfelTemperature:
    Measured temperature of XFEL booster 1.
- xfelHumidity:
    Measured humidity of XFEL booster 1.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- log:
    Logging settings
- adc:
    fast ADC input device
- selectedAdcChannel:
    fast ADC channel in use for the loop
- maxPeakValue:
    Max absolute value for ADC peak. When peak is above this value step is applied
- tuneStage:
    motor controlling the stage to adjust laser path
- stageStep:
    value of stage tuning step size
- loopPeriod:
    Time interval for feedback cycle
- doublecheckWaitTime:
    after peak is above max, this time is waiting to check itagain, before applying step
- calibStepSize:
    Size of calibration step
- calibStepNum:
    Number of calibration steps
- calibAverageNum:
    number of peak values to be averaged for each calibration step
- reverseDirection:
    Set to True at configuration time if direction of stage movement is meant to be inverted (direction changes if the instance is meant to be used for FXE or SPB)
- conversionFactor:
    micrometers to femtoseconds conversion factor
- adcValueTimeout:
    if ADC value is not updated within this time, device goesin error state
- amphosAmpli:
    Karabo ID of Amphos Laser Amplifier
- triggerDelayDevice:
    Karabo ID of pplDelayControl device, used to read Pockels cell status
- moveToPlus:
    Move to +x position
- moveToMinus:
    Move to -x position
- moveToZero:
    Move to 0 position
- pathToProgramFiles:
    The path for program files (RTC5Dat.dat, RTC5Out.out and RTC5Rbf.rbf)
- correctionFile:
    The correction (.ct5) file, including path.
- useExternalTrigger:
    Use external trigger (if true) or auto-run (if false).
- startFromMinusX:
    Set loop initial position to -X
- jumpSpeed:
    The up/down jump speed [bits/ms].
- jumpAmplitude:
    The up/down jump amplitude [bits].
- delayTimePlus:
    Delay time, after moving to position +x.
- delayTimeMinus:
    Delay time, after moving to position -x.
- onTargetTolerance:
    The tolerance [bits] when checking that Galvo is on target position.
- onTargetPlus:
    Galvo is currently at +x position _and_ not moving.
- onTargetMinus:
    Galvo is currently at -x position _and_ not moving.
- laserOn:
    The value of the LASERON signal.
- digitalOut1:
    The value of the DIGITAL OUT1 signal.
- stopEventCode:
    Stop event code.
- galvoTemperature:
    Galvanometer scanner temperature.
- servoTemperature:
    Servo board temperature.
- agcVoltage:
    AGC voltage (PD supply voltage).
- dspCoreVoltage:
    DSP core supply voltage (1.8 V).
- dspIoVoltage:
    DSP IO voltage (3.3 V).
- analogSectVoltage:
    Analog section voltage (9 V).
- adConverterVoltage:
    AD converter supply voltage (5 V).
- galvoHeatingOut:
    Relative heating output of the corresponding galvanometer scanner heater.
- beamline:
    Beamline where to operate
- timingDevice:
    Device ID of PPL Delay Control Device
- galvoDevice:
    id of Galvo Controller
- downstreamSpectr1Device:
    Spectrometer 1 (FXE/SCS)
- upstreamSpectr1Device:
    Spectrometer 1 (SPB/SQS)
- currentExperiment:
    Current MASTER experiment (UPSTREAM or DOWNSTREAM)
- currentVersion:
    Current version
- correctionFactorMaster:
    Correction Factor Master
- correctionFactorSlave:
    Correction Factor Slave
- switchProgress:
    Switching Progress
- switchExperiment:
    Procedure to automatically swap between FXE and SPB delay control and Galvo settings
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- lastError:
    Last error message received. Time is set by front-end firmware.
- scpiTimeout:
    The SCPI communication timeout.
- baseFreq:
    dividing factor for 54 Mhz seeder Frequency. Valid values are 12 (4.5 MHz) and 18 (3 MHz)
- frontendReset:
    send reset command
- s7ack:
    acknowledge to s7 command
- s8ack:
    acknowledge to s8 command
- s9ack:
    acknowledge to s9 command
- laserEmission:
    True when laser ON, false when OFF
- generalStatus:
    True = OK, False = not OK
- temperatureStatus:
    True = OK, False = not OK
- delayBoardStatus:
    True = OK, False = not OK
- inputPin0Status:
    True = OK, False = not OK
- inputPin4Status:
    True = OK, False = not OK
- pd1Voltage:
    Photodiode 1 (TAB 2) voltage
- pd1VoltageAverage:
    Averaged PD1 (TAB 2) voltage
- pd2Voltage:
    Photodiode 2 (TAB 5) voltage
- pd2VoltageAverage:
    Averaged PD2 (TAB 5) voltage
- pd3Voltage:
    PD3 (SPCO 1) voltage
- pd3VoltageAverage:
    Averaged PD3 (SPCO 1) voltage
- pd4Voltage:
    PD4 (TAB 7) voltage
- pd4VoltageAverage:
    Averaged PD4 (TAB 7) voltage
- pd5Voltage:
    PD5 (SPCO2) voltage
- pd5VoltageAverage:
    Averaged PD5 (SPCO2) voltage
- pd6Voltage:
    PD6 voltage
- pd6VoltageAverage:
    Averaged PD6 voltage
- pd7Voltage:
    PD7 voltage
- pd7VoltageAverage:
    Averaged PD7 voltage
- pd8Voltage:
    PD8 voltage
- pd8VoltageAverage:
    Averaged PD8 voltage
- seederOutPower:
    photodiode 1
- xf1OutPower:
    Photodiode 7
- xf2OutPower:
    Photodiode 8
- seederStatus:
    True = OK, False = not OK
- generalSeederStatus:
    True = OK, False = not OK
- hiltiErrorStatus:
    True = OK, False = not OK
- remoteControl:
    if it is false we cannot see it
- regOnOff0:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- regOnOff1:
    Variable RegOnOff represents the state of the 4-channel servo loops of the addressed tool.
- setpAX0:
    Variable SetpAx[0] define the setpoint of the servo loop.
- setpAY0:
    Variable SetpAy[0] define the setpoint of the servo loop.
- sumA0:
    Sum signal of angle detector ‘A’
- sumB0:
    Sum signal of position detector ‘B’
- aX0:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY0:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX0:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY0:
    Variable By represents the measured position deviation in y direction from zero position
- rAX0:
    Regulator Output Ax
- rAY0:
    Regulator Output Ay
- rBX0:
    Regulator Output Bx
- rBY0:
    Regulator Output By
- rAXM0:
    Regulator Output AxM
- rAYM0:
    Regulator Output AyM
- rBXM0:
    Regulator Output BxM
- rBYM0:
    Regulator Output ByM
- setpAX1:
    Variable SetpAx[1] define the setpoint of the servo loop.
- setpAY1:
    Variable SetpAy[1] define the setpoint of the servo loop.
- sumA1:
    Sum signal of angle detector ‘A’
- sumB1:
    Sum signal of position detector ‘B’
- aX1:
    Variable Ax represents the measured angle deviation in x direction from zero position
- aY1:
    Variable Ay represents the measured angle deviation in y direction from zero position
- bX1:
    Variable Bx represents the measured position deviation in x direction from zero position
- bY1:
    Variable By represents the measured position deviation in y direction from zero position
- rAX1:
    Regulator Output Ax
- rAY1:
    Regulator Output Ay
- rBX1:
    Regulator Output Bx
- rBY1:
    Regulator Output By
- rAXM1:
    Regulator Output AxM
- rAYM1:
    Regulator Output AyM
- rBXM1:
    Regulator Output BxM
- rBYM1:
    Regulator Output ByM
- stage1Id:
    Karabo device ID of first grating motor
- stage2Id:
    Karabo device ID of first grating motor
- tunnel:
    Location where doocs_device is deployed (e.g. ‘SASE1’)
- labx2MName:
    DOOCS name of X2 Master doocs_device
- labx2SName:
    DOOCS name of X2 Slave doocs_device
- timingShifterName:
    DOOCS name of Phase Shifter doocs_device
- manualTuning:
    Manual Tuning Enable
- useShifter:
    Set to True if optical synchronization is available
- midTsValue:
    Mid Value of Phase Shifter
- maxTsDelay:
    Maximum delay to add/subtract to phase shifter position
- maxTsJitter:
    Maximum allowed jitter
- laserOpModeList:
    Select Laser Op Mode
- activeLaserOpMode:
    Active Op laser Mode
- laserOpModeListApply:
    Apply Laser Operation Mode
- dmBCCAuto:
    Automatic loop on/off
- pCellState:
    Status of Pockels Cell, True = On
- pCellOn:
    Set Pockels cell on
- pCellOff:
    Set Pockels cell off
- AOMState:
    Status of AOM, True = On
- AOMOn:
    Set AOM on
- AOMOff:
    Set AOM off
- maxAllowedPcPhase:
    Maximum value for Master and Slave Pockels cell phase. Values will wrap when this is exceeded.
- mPCCLKPhase:
    Master PC Phase
- mSWPCCLKPhase:
    Master SW PC Phase
- mBurstWidth:
    Master burst width [us]
- mBurstWidthApply:
    Apply m Burst Width
- mBurstStart:
    Begining of the bursts the slave burst is +50ms)
- mBurstStartsms:
    Master burst starts pos. [us]
- sBurstStartsms:
    Sleve burst starts pos. [us]
- smBurstDiff:
    Different between muster and slave burst positione
- sPCCLKPhase:
    Master PC Phase
- sSWPCCLKPhase:
    Slave software PC PHase
- sBurstWidth:
    Slave burst width [us]
- sBurstWidthApply:
    Apply S Burst width
- delayBPMaster:
    Current delay of the master bunch pattern in clock unit (machine)
- delayBPMasterP:
    Increment Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterM:
    Decrement Master Bunch Pattern delay by 1 clock unit, equivalent to 9.23 ns (machine)
- delayBPMasterP24:
    Increment Master Bunch Pattern delay by 24 clock unit
- delayBPMasterM24:
    Decrement Master Bunch Pattern delay by 24 clock unit
- delayBPSlave:
    Current delay of the slave bunch pattern in clock unit (machine)
- delayBPSlaveP:
    Increment Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveM:
    Decrement Slave Bunch Pattern delay of multiple of 9.23 ns (machine)
- delayBPSlaveP24:
    Increment Slave Bunch Pattern delay by 24 clock unit
- delayBPSlaveM24:
    Decrement Slave Bunch Pattern delay by 24 clock unit
- masterExpPattern:
    Select pattern for master experiment
- slaveExpPattern:
    Select pattern for slave experiment
- currentLaserPatterns:
    Current Laser Patterns
- currentMasterLaserPattern:
    Current Master Laser Patterns
- currentSlaveLaserPattern:
    Current Slave Laser Patterns
- currentSlaveLaserPatternN:
    Current Slave Laser Pattern
- fineDelayMaxCounts:
    Fine delay - maximum count number
- fineDelayValue:
    fine delay count value
- fineDelayValueT:
    fine delay time value
- fineDelayP:
    Increment fine delay
- fineDelayM:
    Decrement fine delay
- fineDelay9nsChange:
    Change Fine Delay by 9.23ns If == true current value + 9ns, if ==false -9.23ns
- fineDelay9ns:
    Change Fine Delay by 9 ns
- minTsPosition:
    Minimum Timing Shifter Delay
- maxTsPosition:
    Maximum Timing Shifter Delay
- currentTsPosition:
    current value of time shifter position
- requestedTsDelay:
    Delay to apply to the phase shifter
- DelayTsChange:
    Change phase shifter by requested value
- relAbsolutTsPos:
    True for relative, False for absolute
- stopPsChange:
    Abort phase shift change
- opticalSynch:
    Display status of optical synchronization
- opticalSynchLock:
    Display lock status of optical synchronization
- opticalSynchJitter:
    Display status of optical synchronization jitter
- opticalSynchMode:
    Optical synch. mode (RF / Optical)
- setOpticalDelay:
    Delay to apply to optical delay line
- applyOpticalDelay:
    change the optical delay by requeste value
- currentOpticalDelay:
    Current position of optical delay
- relAbsolutDelayLine:
    True for relative, False for absolute
- TsJitter:
    Optical Synchronization Jitter
- triggerFE_DOWNSTREAM:
    Current trigger delay FE DOWNSTREAM
- triggerFE_UPSTREAM:
    Current trigger delay FE UPSTREAM
- getCurrentHardwareStatus:
    Read configuration from hardware
- lastShiftDelay:
    FE delay value from the prevoius shift
- setLastShiftDelay:
    Bring the delay to position from the previus shift
- clearLock:
    In case of STATE == changing bring the state to Normal
- mPCCLKPhaseSetValue:
    Master PC CLK Phase Value
- sPCCLKPhaseSetValue:
    Slave PC CLK Phase Value
- delayBPMasterSetValue:
    Master BP delay Value
- delayBPSlaveSetValue:
    Slave BP delay Value
- resetError:
    Reset error count.
- upstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for upstream instrument
- downstreamTimingDrifCompensatorId:
    Karabo ID of Timing Drift Compensator device for downstream instrument
- shiftChange:
    Swaps MASTER and SLAVE properties between upstream and downstream instrument
- isOxcActive:
    Status of optical lock (True: OPTICAL mode, False: RF mode)
- requestedDelay:
    Relative delay to be applied by delay change (Trigger Position)
- delayChange:
    Change delay value by applying (relative) offset
- mPCCLKPhaseP:
    Increment PC master Phase
- mPCCLKPhaseM:
    Decrement PC master Phase
- sPCCLKPhaseP:
    Increment slave PC Phase
- sPCCLKPhaseM:
    Decrement slave PC phase
- savemSWPCCLKPhase:
    Save new software phase value for PCm
- savesSWPCCLKPhase:
    Save new software phase value for PCs
- mBurstStartApply:
    Apply Burst Start Pos
- takemidTsValue:
    Take mid value of phase shifter
- logBoardsStatus:
    JSON string describing master and slave board settings.Usually updated when user actions are taken
- logFineDelay:
    JSON string describing fine delay settings.Usually updated when user actions are taken
- imgprocDevice:
    Device ID of image processor used for feedback
- temDevice:
    id of tem device
- temChannel:
    TEM channel to be controlled
- xCoefWeight:
    weight of X coefficient
- yCoefWeight:
    weight of Y coefficient
- axCoefOld:
    Value of Ax Coefficient saved prior to calibration
- ayCoefOld:
    Value of Ay Coefficient saved prior to calibration
- xBeamCenterTarget:
    desired value for Beam Center X coordinate
- yBeamCenterTarget:
    desired value for Beam Center Y coordinate
- beamCenterMaxDisplacement:
    maximum allowed displacement for Center of Mass from target position
- maxTemDrift:
    Maximum value allowed for TEM drift
- averageNumber:
    number of values of beam center coordinates to average
- timeoutImageProcessorValues:
    Time to wait before going in error when values from image processor are not updating
- imageSettlementTime:
    Time to wait before reading beam center coordinates aftermoving TEM setpoint
- calibrationStep:
    TEM setpoint step size for calibration
- calibrationStepsNumber:
    Number of TEM calibration steps
- maxTimeNotRegulating:
    When TEM is not regulating, wait this time trying before going into error state. Use this is to deal with temporary HW failures.
- setCurrentPosAsTarget:
    Set current beam position as target
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.
- cppServerId:
    The cppServer where the beckhoffCom is running on
- beckhoffId:
    The deviceId of beckhoffCom to contact, chosen among PLCs discovered in the system.
- blacklist:
    These devices won’t be instantiated etc.
- groups:
    The available component groups
- components:
    The available components
- instantiateWait:
    The deviceId of beckhoffCom to monitor
- availableScenes:
    Scenes from the PplPattern
- timeoutConnectToBCom:
    Timeout for succesfully connect to PLC
- timeoutReadDevConfig:
    Timeout for getting the same number of failures when reading the configuration of devices
- setDefaultDevConfig:
    Set/Unset device configuration following the DEFAULT section in config template. In case itis True Timeout for succesfully get the configuration of a device
- outputFileRoot:
    Template string for output XML file
- inputFileTemplate:
    File with variables to save in FW
- configDir:
    Folder to store configuration files
- plcInFwTemplate:
    List of PLCs which have a specific configuration to save, as found in the FW Template
- instantiateDevices:
    Issues devices instantiation. Existing devices will trigger an ERROR log message. NOTICE: The devices instantiated in this way will have default configurations, e.g. Alarm Limits will not be set. Shutdown and re-instantiate from the project if necessary.
- instantiateQuick:
    Instantiate all devices on selected PLC quickly
- instantiateGroupDevices:
    Instantiate all selected group devices in selected PLC
- instantiateComponentDevices:
    Instantiate all selected component devices in selectedPLC
- resetDevices:
    Reset all devices in Error state
- getOfflineDevices:
    Check which devices are still offline
- shutdownDevices:
    Shutdown all devices
- shutdownGroupDevices:
    Shutdown all group devices
- shutdownComponentDevices:
    Shutdown all component devices
- getPLCsInFwTemplate:
    Get the list of PLCs in Firmware Template which require a config different from what is stated in DEFAULT.
- getPLCsInSystem:
    Get list of PLCs active in current topic
- handleMultiConfigToXML:
    The retrieved config of devices in PLCs is written on an XML file
- handleSingleConfigToXML:
    The retrieved config of devices in selected beckhoffId is written in XML file
- cameraClasses:
    Camera classes to be considered
- timeout:
    After that camera is stuck for this long, its watchdog takes action
- maxAttempts:
    After this number of consecutive attempts to recover, the device goes in error state
- cameras:
    Cameras in topology
- collectiveAlarm:
    Global alarm, set when at least one of devices is not ON
- guideAlarm:
    Global alarm, set when at least one of devices is not ON
- flowAlarm:
    Alarm set when the water level is below threshold
- pressureAlarm:
    Alarm set water pressure is outside nominal range
- temperatureAlarm:
    Alarm set when water temperature is above critical value
- levelAlarm:
    Alarm set when water leve is below threshold
- doocsTimerCentral:
    Doocs address of central timer
- doocsX2Master:
    Doocs address of X2 master board
- doocsX2Slave:
    Doocs address of X2 slave board
- timeServer:
    Time Server device ID
- instrument:
    Instrument data refers to
- isMaster:
    Active experiment is the master. When instrument is slavePPL data are not relevant
- triggerDelay:
    The trigger delay.
- serverOfDevice:
    The server running the selected device.
- classOfDevice:
    The class of the selected device.
- actionOfDevice:
    Action to be taken after instantiation. This list populated with the posibble actions (slots) available in the selected device. In case no action is selected, the device will be initialized only.
- awaitedStateOfDevice:
    Action can be taken only after a desired state is reached. In case no state is specified, the action will be launched immediately after the device is instantiated. This parameter is auto-filled if a project is selected.
- configurationOfDevice:
    Configuration ID. The active configuration ID can be found right-clicking on the device in the project, selecting the item ‘About’ in the drop-up menu, and taking the value of the parameter ‘active_config_ref’.
- cancelDeviceAddition:
    The current selection of device configuration is canceled.
- persistConfig:
    The active list of devices configuration is saved for future use.
- jobTimeout:
    Timeout for starting the devices. The user can set a value between 30 seconds and 5 minutes.
- autoStart:
    Automatic start of devices at instantiation
- interfaces:
    Describes the interfaces of this device
- home:
    Start homing procedure.
- move:
    Move to target position.
- stepUp:
    Move to actual position plus step length.
- stepDown:
    Move to actual position minus step length.
- calibrateTarget:
    The motor scale is set to this position when hitting calibrate
- isOnTarget:
    Indicates whether the motor is on target or not.
- actualPosition:
    Actual position of the motor. If an encoder is activated, this represents the encoder position.
- stepCounterPosition:
    Motor position calculated from counter steps (instead of encoder values). ONLY valid if connected to external encoder.
- targetPosition:
    Hardware target position as read from the device
- targetVelocity:
    Target velocity in velocity mode.
- modus:
    Operation mode: 0 - velocity mode; 1 - position mode; 2 - backlash mode; 3 - not implemented (reserved); 4 - master/slave mode.
- masterMotor:
    Define master motor for master/slave operation mode.
- stepLength:
    Step length used in StepUp/StepDown.
- isIdleOpenLoop:
    True - Stopped on target; False - Idle on target (follows encoder position).
- isCWLimit:
    Is at hardware end-switch high - CW limit.
- isCCWLimit:
    Is at hardware end-switch low - CCW limit.
- isSWLimitHigh:
    Is at software limit high.
- isSWLimitLow:
    Is at software limit low.
- isInterlockLimitHigh:
    Is at interlock limit high.
- isInterlockLimitLow:
    Is at interlock limit low.
- isSlave:
    The motor is configured as slave in a coordinated motion.
- masterSlaveCorrelation:
    The velocity of the slave motor is the velocity of the master multiplied by this factor (Only useful in mode 4).
- gear:
    Conversion factor in [micro-steps/targetUnit]. Convert with 64 micro-steps per step.
- encodeStep:
    Size of encoder increment in target unit; Without Encoder: Element is the length of a micro-step [1/Gear].
- deadband:
    Within deadband the motor is on target.
- pConst:
    Proportional feedback constant.
- aMax:
    Maximum velocity difference per cycle (EL7041 unit 32767 is full speed).
- acceleration:
    Maximum velocity difference in [targetUnit/s^2].
- vMax:
    Maximum velocity the motor can drive (EL7041 unit 32767 is full speed).
- velocity:
    Maximum velocity in [targetUnit/s] (EL7041 unit 32767 is full speed).
- vMin:
    Minimum velocity expressed in arbitrary terminal units/cycle.
- limitPosL:
    Software limit low.
- limitPosH:
    Software limit high.
- invLogicLim1:
    Limit switch 1 logic: False - active high ; True - active low.
- invLogicLim2:
    Limit switch 2 logic: False - active high ; True - active low.
- isInvertLimits:
    Logic calibration: False - Limits active high (24 V); True - limits active low (0 V).
- isInternalCounter:
    False - No step counter in terminal available; True - Internal counter from terminalis used.
- maxCurrent:
    Maximum motor current.
- reducedCurrent:
    Reduced current, when Idle or stopped - Holding current.
- backlash:
    Backlash distance. ONLY valid in modus 2.
- plcCycleAveraging:
    Number of PLC Cycles after which the averaged encoder value is sent out.
- isLimitless:
    Set to True for limit less axes - e.g. filter wheels.
- homeUp:
    False - default homing searches down for a home switch; True - will search up for a home switch instead.
- homeNoLimit:
    False - Homing searches for a limit switch first and then searches for a home switch starting at limit; True - search for home switch directly.
- saveLimitPosition:
    Save Hardware limit position to the soft limit position.
- checkLimitConsistency:
    Check for limit consistency. NOTE: Motor state switches to error in case of moving in high direction (H/W coordinates) triggers H/W limit low.
- terminalTemperature:
    Terminal Temperature.
- controllerVoltage:
    Voltage of the controller section of the terminal.
- motorDriverVoltage:
    Voltage of the motor driver.
- syncEncoder:
    True - Synchronizes motor and encoder terminal in time (offset cancellation). This offset is kept until a new trigger of this property; False - No synchronization is triggered.
- extEncoderEnabled:
    True - Use external encoder; False - Don’t use external encoder for position reference.
- extEncoderName:
    Declare device name for external encoder.
- relativeDeadband:
    if target and actual positions have a relative difference smaller than this property the ‘move’ command will not be sent to the PLC.
- serverUri:
    URI of the PLC server in the form ‘[tcp://]host[:port]’. Default scheme ‘tcp’ and default port 1234 are added automatically, if not specified.
- serverTimeout:
    Timeout for server responses.
- autoResetTime:
    Time to wait before an automatic reset on the device is attempted. Can be set before instantiation.
- connectionSettlingTime:
    Minimum duration of a successful connection to the PLC. A connection shorter than this will increase the ‘Failed Connection Attempts’ number
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- plcUptime:
    Total time (in seconds), that the PLC server is up and running
- createGenericDevices:
    If enabled, BeckhoffCom creates generic Karabo devices for all PLC devices, which are not yet instantiated.
- messageRateOut:
    The average rate of messages sent by BeckhoffCom
- messageRateIn:
    The average rate of messages received by BeckhoffCom
- byteRateOut:
    The average rate of bytes sent by BeckhoffCom
- byteRateIn:
    The average rate of bytes received by BeckhoffCom
- availablePlcDevices:
    Lists all available PLC devices
- updatesRate:
    The average rate of updates to the Beckhoff Devices
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- ACpuFrequency:
    Frequency of the CPU.
- ACurrentCpuUsage:
    Current CPU usage.
- ACurrentCpuTemperature:
    Current temperature of the CPU.
- AProgramMemoryAllocated:
    Allocated program memory.
- AProgramMemoryAvailable:
    Available program memory.
- AStorageMemoryAllocated:
    Allocated storage-memory. Available on Windows CE.
- AStorageMemoryAvailable:
    Available storage-memory. Available on Windows CE.
- AMemoryDivision:
    MemoryDivision. Available on Windows CE.
- AProgramMemoryAllocated2:
    Allocated program memory.
- AProgramMemoryAvailable2:
    Available program memory.
- AMacAddess:
    MAC-Address of the PLC (17 char string).
- AIpv4Address:
    Current IPv4 Address of the PLC in dotted notation (15 char string).
- AIpv4SubnetMask:
    IPv4 subnet mask of the PLC in dotted notation (15 char string).
- ADhcpServerIpv4Address:
    IP-Address of the DHCP-Server in dotted notation (15 char string).
- ADhcpServerEnabled:
    True if the DHCP-Server is enabled.
- AMainboardType:
    Type of the main-board.
- ASerialNumber:
    Serial number.
- AProductionDate:
    Production date of the main-board.
- ABootCount:
    Boot count.
- AOperatingTimeInMinutes:
    Operating time of the main-board.
- AMinBoardTemperature:
    Minimum temperature of the main-board.
- AMaxBoardTemperature:
    Maximum temperature of the main-board.
- MinInputVoltage:
    Minimum input voltage of the main-board.
- MaxInputVoltage:
    Maximum input voltage of the main-board.
- MainboardTemperature:
    Current temperature of the main-board.
- APlcProjectVersion:
    PLC Project Version
- AProjectGeneratorVersion:
    Project Generator Version
- ATCPBufferSize:
    TCP/IP buffer size.
- ATrainID:
    Train ID
- ABeamModes:
    Beam Modes
- ATCPOutputDataRate:
    TCP Output Data Rate
- ATCPOutputBufLvlMax:
    TCP Output Buf Lvl Max
- ATCPInputDataRate:
    TCP Input Data Rate
- ATCPInputBufLvlMax:
    TCP Input Buf Lvl Max
- APLCCycleTime:
    PLC Cycle Time
- inFrameRate:
    The input frame rate.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    The integration time.
- x0:
    Mean-wavelength calculated as the center-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:
    True if fit succeeded, False otherwise
- 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.
- 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.
- wavelengths:
    The vector of wavelengths.
- getWavelengths:
    Get wavelengths vector from spectrometer Karabo device
- spectrumIntegral:
    Sum of spectrum counts. It provides a relative measurement of the signal intensity
- fitSelect:
    Select curve to fit the peak
- isFitResultAccepted:
    True if fit peak position falls inside the spectrometer range AND its relative uncertainty is lower than threshold “Max relative uncertainty” .
- fitAmpl:
    Amplitude from selected fit.
- fitPos:
    center of selected fit
- fitMaxWavelength:
    wavelength that corresponds to maximum of selected fit
- fitSigma:
    Sigma for selected Fit.
- maxRelativeFitSigma:
    If relative uncertainty of evaluated peak position exceeds this value, fit result is not deemed as valid.
- fWHM:
    Full Width at half the Maximum for selected fit
- fWHMWavelength:
    Full Width at half the in wavelength (approximating wavelength linear dependency around the peak)
- rawFwhm:
    FWHM calculated wrt maximum of raw data.
- rawPeakPos:
    Wavelength that corresponds to maximum of raw data.
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- resetSpectrometer:
    Resets the spectrometer in case of an error
- delayTime:
    The delay between two spectra.
- bkgSpectrum:
    The background spectrum.
- bkgFile:
    The file containing the background spectrum.
- saveBkgSpectrum:
    Save background spectrum to file
- loadBkgSpectrum:
    Load background spectrum from file
- useCurrentBkgSpectrum:
    Use current spectrum as background
- subtractBkgSpectrum:
    Subtract background spectrum
- refSpectrum:
    The reference spectrum.
- refFile:
    The file containing the reference spectrum.
- saveRefSpectrum:
    Save reference spectrum to file
- loadRefSpectrum:
    Load reference spectrum from file
- useCurrentRefSpectrum:
    Use current spectrum as reference
- acqRate:
    The actual acquisition rate. It is refreshed once per second.
- hwRevision:
    The spectrometer hardware revision.
- fwRevision:
    The spectrometer firmware revision.
- deviceAlias:
    User-defined name for the device.
- temperature1:
    Detector Board Thermistor.
- temperature3:
    Microcontroller Sensor Temperature.
- correctedSpectrum:
    During acquisition gets corrected spectrum.
- strobeEnable:
    The strobe enable status: 0=OFF, 1=ON.
- shutdownMode:
    The shutdown mode: 0=Shutdown !0=Power Up
- tickFactor:
    The number defining which tick should be broadcasted. Example: 10 means “every tenth tick”
- 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)
- 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.
- interValvesState:
    The current state of pipe in-between pump and valves.It is ON/OFF in case all valves are closed/open.
- loopPollTime:
    The interval in which the watchdog monitors the relevant variables.
- pumpDownTimeoutStartup:
    Soon after device startup go in error state if desired vacuum is not reached before this timeout expires.
- depressureTime:
    Go in error if pressure goes above max limit faster than this value.
- pumpSectionTime:
    Time to wait when the pump is started before opening valves
- chamberPressureUpstream:
    Gauge device to monitor the pressure in upstream laser pipe
- chamberPressureDownstream:
    Gauge device to monitor the pressure in downstream laser pipe
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- open:
    Instructs device to open
- close:
    Instructs device to close
- maxSwTime:
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low

Release History
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

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

## SA1

[add component documentation]

### XTD9

[add component documentation]

#### VAC

[add component documentation]

##### SWITCH

[add component documentation]

###### VALVE_V11260M_open_SPB

Instance id: | SA1_XTD9_VAC/SWITCH/VALVE_V11260M_open_SPB
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-01
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-01
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.4-2.11.1
Scenes: | Instrument-Overview-Long, MPS-SPB_VALVES_OPEN, SPB_SYS_VAC2MPS_DCTRL_SPB_VALVES_OPEN_INTERLOCK, MPS-SPB_VALVES_OPEN, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T09:55:43.000Z
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

##### VALVE

[add component documentation]

###### V11260M

Instance id: | SA1_XTD9_VAC/VALVE/V11260M
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | SA1_OVERVIEW_VACUUM, SA1_OVERVIEW_VACUUM
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock 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
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- isOpened:
    Status limit switch opened.
- isClosed:
    Status limit switch closed.
- invertValue:
    1=invert coil logic
- invertLimits:
    0=Limits active high 1=limits active low
- targetPosition:
    Hardware target position as read from the device

Release History
4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T09:55:43.000Z
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

#### SYS

[add component documentation]

##### TSYS

[add component documentation]

###### UTC-R114-S4

Instance id: | SA1_XTD9_SYS/TSYS/UTC-R114-S4
Class id: | X2Timer
Host: | spb-rr-sys-con-06
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/doocsDevices
Last modified: | 2021-06-04T16:16:24.000+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Hauf, Mamchykd, Parenti
Latest tag: | 1.8.12-2.10.4
Deployment tag: | 1.8.12-2.10.4
Installed tag: | 1.8.8-2.10.0
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.8.8-2.10.0) does not match tags mentioned in the deployment ([‘1.8.12-2.10.4’])!

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.12-2.10.4

Created: | 2021-05-05T10:20:05.000Z
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-21T14:09:17.000Z
Author: | Alessandro Silenzi
Notes: | FIX: cast delay to integer to comply with Karabo 2.11

1.8.10-2.10.2

Created: | 2021-02-10T14:47:03.000Z
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-12T12:38:56.000Z
Author: | Andrea Parenti
Notes: | Summary: * FEATURE inject runtime properties; * FIX initialization of DoocsOpticalDelay.

1.8.8-2.10.0

Created: | 2020-11-24T07:05:35.000Z
Author: | Steffen Hauf
Notes: |

1.8.7-2.9.4

Created: | 2020-11-12T15:46:42.000Z
Author: | Riccardo Fabbri
Notes: | Authorization to write to DOOCS retrieved at property level

1.8.6-2.9.4-fxe-xgmd

Created: | 2020-10-09T14:11:02.000Z
Author: | ehsanw
Notes: | to be used for fxe-xgmd

1.8.6-2.9.4

Created: | 2020-10-07T05:37:53.000Z
Author: | Steffen Hauf
Notes: | Add laser steering to bunch pattern pulser

1.8.5-2.9.1-xgm-log-timestamps

Created: | 2020-09-24T18:09:47.000Z
Author: | ehsanw
Notes: | Added timestamp and train id logging for xgm

1.8.5-2.9.1

Created: | 2020-09-15T07:18:47.000Z
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-02T07:35:59.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Description field added to the table.

1.8.3-2.9.1

Created: | 2020-08-26T10:18:01.000Z
Author: | Wajid Ehsan
Notes: | Bunch Arrival Monitor new parameters

1.8.2-2.9.1

Created: | 2020-08-26T09:20:59.000Z
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-21T11:49:45.000Z
Author: | Steffen Hauf
Notes: | Updates for the bunch pattern pulse

1.8.0-2.9.1-sqs-pattern-delay

Created: | 2020-08-20T12:42:42.000Z
Author: | bondarv
Notes: | For tests only. X2Timer in SQS with additional expected parameter “bunchPatternDelay”

1.8.0-2.9.1

Created: | 2020-08-07T15:10:21.000Z
Author: | Steffen Hauf
Notes: | Add the DoocsMirror device

1.7.0-2.9.1

Created: | 2020-08-05T09:24:35.000Z
Author: | Steffen Hauf
Notes: | Add BunchPatternPulser Device

1.6.7-2.9.1

Created: | 2020-08-04T16:57:39.000Z
Author: | mamchykd
Notes: | Updates for DoocsUndulatorCells device (fix for a proper xml structure and calculation of lastClosedUndulator property value). The tag is ok for deployment

1.6.6-2.9.1-sqs

Created: | 2020-07-24T15:49:52.000Z
Author: | mamchykd
Notes: | Tag from branch (SQS-only). Shortened version of with reduced DoocsXGM properties for SQS

1.6.5-2.9.1

Created: | 2020-07-15T05:47:01.000Z
Author: | Steffen Hauf
Notes: | DoocsUndulatorCells device restored. The tag is ok for deployment

#### MIRR

[add component documentation]

##### MOTOR

[add component documentation]

###### HMTX

Instance id: | SA1_XTD9_MIRR/MOTOR/HMTX
Class id: | BeckhoffSimpleMotor
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- 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.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

#### HIREX

[add component documentation]

##### CAL

[add component documentation]

###### MASTER

Instance id: | SA1_XTD9_HIREX/CAL/MASTER
Class id: | SlsCalibrator
Host: | spb-rr-sys-con-07
Alias: | spb-rr-sys-con-07
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
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Installation not found in a standard path!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- performanceStatistics:
    Accumulates some statistics
- 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.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: |

###### SLAVE

Instance id: | SA1_XTD9_HIREX/CAL/SLAVE
Class id: | SlsCalibrator
Host: | spb-rr-sys-con-07
Alias: | spb-rr-sys-con-07
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
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Installation not found in a standard path!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- performanceStatistics:
    Accumulates some statistics
- 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.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

[add component documentation]

###### BRAGG

Instance id: | SA1_XTD9_HIREX/CAM/BRAGG
Class id: | PhotonicScienceCamera
Host: | spb-rr-sys-con-07
Class documentation:
| PhotonicScienceCamera
Alias: | spb-rr-sys-con-07
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/genicamCameras
Last modified: | 2020-11-24T11:28:59.000+01:00
Created at: | 2017-01-13T10:48:08.000+01:00
Main authors: | Parenti, Hauf
Latest tag: | 3.11.7-2.10.0
Deployment tag: | 3.11.7-2.10.0
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Installation not found in a standard path!

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- performanceStatistics:
    Accumulates some statistics
- interfaces:
    Describes the interfaces of this device
- ipAddress:
    The hostname or IP address of the network camera (eg 131.169.140.193).
- streamPacketSize:
    The stream packet size to send on this channel, except for data leader and data trailer, and the last data packet which might be of smaller size (since packet size is not necessarily a multiple of block size for stream channel).
- streamInterPacketDelay:
    This feature indicates the delay (in timestamp counter unit) to insert between each packet for this stream channel.
- frameRate:
    The actual frame rate.
- bandwidth:
    The actual bandwidth.
- errorCount:
    The number of errors occurred during acquisition.
- lastError:
    Description of the last error occurred during acquisition.
- width:
    This value sets the width of the area of interest in pixels. It must be a multiple of 16.
- height:
    This value sets the height of the area of interest in pixels.
- acquisitionMode:
    This feature controls the acquisition mode of the device.
- acquisitionFrameCount:
    Number of frames to acquire in MultiFrame Acquisition mode
- pollingInterval:
    The interval for polling the camera for read-out values.
- isCameraTimestampEnabled:
    Publish local timestamp
- pixelSize:
    This feature indicates the total size in bits of a pixel of the image.
- xOffset:
    This value sets the X offset (left offset) for the area of interest in pixels, i.e., the distance in pixels between the left side of the sensor and the left side of the image area
- yOffset:
    This value sets the Y offset (top offset) for the area of interest in pixels, i.e., the distance in pixels between the top side of the sensor and the top side of the image area
- xBinning:
    This feature represents the number of horizontal photo-sensitive cells that must be combined (added) together.
- yBinning:
    This feature represents the number of vertical photo-sensitive cells that must be combined (added) together.
- autoGain:
    This feature performs automatic level control (ALC).
- displayMode:
    Select nonstandard display modes. Use to select between low gain, high gain or combined.
- exposureMode:
    This feature is used to set the operation mode of the Exposure (or shutter).
- exposureTime:
    This feature is used to set the Exposure time in device-specific unit when ExposureMode is Timed.
- delayBetweenImages:
    Adds additional delay in us between images in free running mode. Use to slow down the frame rate.
- triggerMode:
    Trigger mode selector.
- pixelFormat:
    This feature indicates the format of the pixel to use during the acquisition.
- powerSaving:
    The power saving mode.
- flickerReduction:
    This feature helps to reduce flicker caused by AC lighting. Only works with exposure times greater than 10ms.
- gammaGain:
    Sets the gain to be applied to the darker parts of the image.
- bestFit:
    Stretches the image to use the displays full dynamic range. If gamma = gammy gain then the dark parts of the image are stretched most. if gamma = one then the image is stretched linearly.
- alcAllowAutoBin:
    If true then binning will be used to improve the image at very low light levels. The image size is not changed by mode. If the Bin filter Feature is Set to True then binning will remain on all the time regardless of this setting.
- columnReduction:
    To remove remaining column structure from image best applied in darkness. Must be off to image.
- offsetCorrection:
    Corrects the image for offset variations.
- gammaSel:
    Selects gamma 1 or gamma gain which is controlled by the Gamma_gain_dark control or the best fit.
- brightPixelCorrection:
    Turns on Bright pixel correction.
- binFilter:
    If true image is binned 2x2 then rescaled to original size.
- bpRemovalStrong:
    Will correct more low level bright pixels when set But also erode edges.
- pixelSpeed:
    Sets the pixel speed in MHz. Only preset values are supported.
- vendorName:
    This feature provides the name of the manufacturer of the device.
- modelName:
    This feature provides the model of the device.
- cameraVersion:
    This feature provides the version of the device.
- cameraId:
    This feature stores a camera identifier.
- sensorWidth:
    This feature indicates the effective width of the sensor in pixels.
- sensorHeight:
    This feature indicates the effective height of the sensor in pixels.
- maxWidth:
    This feature represents the maximum width (in pixels) of the image after horizontal binning, decimation or any other function changing the horizontal dimensions of the image.
- maxHeight:
    This feature represents the maximum height (in pixels) of the image after vertical binning, decimation or any other function changing the vertical dimensions of the image.
- ccdTemperature:
    This feature represents the CCD temperature.
- pldTemperature:
    This feature represents the PCB temperature.

Release History
3.11.7-2.10.0

Created: | 2020-11-24T10:38:08.000Z
Author: | Andrea Parenti
Notes: | Summary: add version info

3.11.6-2.9.8

Created: | 2020-10-27T09:47:57.000Z
Author: | Andrea Parenti
Notes: | Summary: Add support and tests for CentOS 8 and Ubuntu 20.04

3.11.5-2.9.8

Created: | 2020-09-16T06:59:05.000Z
Author: | Andrea Parenti
Notes: | Summary: use standard font in scene

3.11.4-2.8.0

Created: | 2020-03-19T08:25:37.000Z
Author: | Andrea Parenti
Notes: | Update documentation, in particular add ‘troubleshooting’ FIX Install PyQt4 via dependencies - needed by eBUSPlayer FIX Replace xdata user with xkarabo - needed to upload binary to server FIX Use appendSchema instead of updateSchema

3.11.3-2.6.1

Created: | 2019-09-13T11:47:13.000Z
Author: | Andrea Parenti
Notes: | Default values for camera parameters

3.11.2-2.6.0

Created: | 2019-08-27T11:01:03.000Z
Author: | Andrea Parenti
Notes: | FIX frame rate update interval; Simplify updateOutputSchema according to K2.5;

3.11.1-2.6.0

Created: | 2019-08-16T09:54:55.000Z
Author: | Andrea Parenti
Notes: | Add support for Ubuntu 18.04

3.11.0-2.5.0

Created: | 2019-07-19T07:51:45.000Z
Author: | Andrea Parenti
Notes: | FIX: Set stream parameters on connection FEAT: Integration of Photon detector

3.10.5-2.5.0

Created: | 2019-07-11T11:39:16.000Z
Author: | Andrea Parenti
Notes: | FIX crash when clicking on ‘connect’ button for unavailable camera FIX options for read-only parameters FIX readOnConnect parameters are read after successful connection

3.10.4-2.4.0

Created: | 2019-04-08T15:15:23.000Z
Author: | Gabriele Giovanetti
Notes: | cameraTimestamp published on device parameters

3.10.3-2.4.0

Created: | 2019-03-29T08:14:07.000Z
Author: | Gabriele Giovanetti
Notes: | cameraTimesamp as UINT64 in the output channel (do not use as Data Aggregator seems to crash )

3.10.2-2.3.6

Created: | 2019-03-19T08:55:42.000Z
Author: | Gabriele Giovanetti
Notes: | Added Mono16 option on Basler Camera

3.10.1-2.3.5

Created: | 2019-03-04T14:02:35.000Z
Author: | Andrea Parenti
Notes: | FIX BobcatCamera::getBinning

3.10.0-2.2.6

Created: | 2018-11-14T15:03:25.000Z
Author: | Andrea Parenti
Notes: | Add support to Mono12Packed mode

3.9.0-2.2.6

Created: | 2018-11-06T10:00:51.000Z
Author: | Andrea Parenti
Notes: | Add Pixel_Speed parameter to Photonic Science

3.8.0-2.2.6

Created: | 2018-11-05T12:43:55.000Z
Author: | Andrea Parenti
Notes: | Remove file saving feature

3.7.1-2.2.4

Created: | 2018-06-05T11:27:42.000Z
Author: | Andrea Parenti
Notes: | Fix default value for PhotonicScience’s width. Set image binning.

2.2.4rc9

Created: | 2018-06-05T11:27:42.000Z
Author: | Andrea Parenti
Notes: |

3.7.0-2.2.3

Created: | 2018-05-29T14:44:29.000Z
Author: | Andrea Parenti
Notes: | FEAT: Add camera scene FIX: Use “latest_build” as KARABO_TAG when testing package. FIX: Update the DAQ output schema if - and only if - there is a change in image’s height, width or bpp. Set default value for height, width and pixelSize.

3.6.6-2.2.1

Created: | 2018-02-20T10:53:47.000Z
Author: | Andrea Parenti
Notes: | Fix: daqOutput schema is initialized when connecting to camera

##### DAQ

[add component documentation]

###### GOTTHARD_MASTER

Instance id: | SA1_XTD9_HIREX/DAQ/GOTTHARD_MASTER
Class id: | GotthardReceiver
Host: | spb-rr-sys-con-07
Class documentation:
| GotthardReceiver
Alias: | spb-rr-sys-con-07
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
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Installation not found in a standard path!

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- 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

###### GOTTHARD_SLAVE

Instance id: | SA1_XTD9_HIREX/DAQ/GOTTHARD_SLAVE
Class id: | GotthardReceiver
Host: | spb-rr-sys-con-07
Class documentation:
| GotthardReceiver
Alias: | spb-rr-sys-con-07
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
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Installation not found in a standard path!

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- 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

##### DET

[add component documentation]

###### GOTTHARD

Instance id: | SA1_XTD9_HIREX/DET/GOTTHARD
Class id: | GotthardControl
Host: | spb-rr-sys-con-07
Class documentation:
| GotthardControl
Alias: | spb-rr-sys-con-07
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
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Installation not found in a standard path!

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- performanceStatistics:
    Accumulates some statistics
- 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

##### ENC

[add component documentation]

###### DETECTOR_X

Instance id: | SA1_XTD9_HIREX/ENC/DETECTOR_X
Class id: | BeckhoffEncoder
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- 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.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

##### MOTOR

[add component documentation]

###### ABSORBER_X

###### CRYSTALUNIT_X

###### CRYSTALUNIT_Y

###### CRYSTAL_RX

###### CRYSTAL_X

###### DETECTOR_RX

###### DETECTOR_X

Instance id: | SA1_XTD9_HIREX/MOTOR/DETECTOR_X
Class id: | BeckhoffSimpleMotor
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- 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.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

###### GRATING_RX

Instance id: | SA1_XTD9_HIREX/MOTOR/GRATING_RX
Class id: | BeckhoffSimpleMotor
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- 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.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

###### GRATING_X

###### GRATING_Y

##### PROC

[add component documentation]

###### BRAGG

Instance id: | SA1_XTD9_HIREX/PROC/BRAGG
Class id: | ImageProcessor
Host: | spb-rr-sys-con-07
Class documentation:
| ImageProcessor
Alias: | spb-rr-sys-con-07
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
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Installation not found in a standard path!

Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- 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.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

[add component documentation]

###### ABSORBER_TEMP

Instance id: | SA1_XTD9_HIREX/TSENS/ABSORBER_TEMP
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.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

###### CRYSTAL_TEMP

Instance id: | SA1_XTD9_HIREX/TSENS/CRYSTAL_TEMP
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.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

###### GRATING_TEMP

Instance id: | SA1_XTD9_HIREX/TSENS/GRATING_TEMP
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.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

#### IMGPII45

[add component documentation]

##### CAM

[add component documentation]

###### BEAMVIEW_SHIMADZU

### BR

[add component documentation]

#### SYS

[add component documentation]

##### PLC

[add component documentation]

###### SPB_PLCMON

Instance id: | SA1_BR_SYS/PLC/SPB_PLCMON
Class id: | BeckhoffPlcMonitor
Host: | exflcon53n0
Class documentation:
| BeckhoffPlcMonitor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | SPB_RR_SYS/MDL/BKF_CONF|TrainId Overview
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.
- 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.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

### CTRL

[add component documentation]

#### NBUNCH

[add component documentation]

##### DOOCS

[add component documentation]

###### XRAY_POD

Instance id: | SA1_CTRL_NBUNCH/DOOCS/XRAY_POD
Class id: | DoocsPulseKicker
Host: | spb-rr-sys-con-06
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/doocsDevices
Last modified: | 2021-06-04T16:16:24.000+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Hauf, Mamchykd, Parenti
Latest tag: | 1.8.12-2.10.4
Deployment tag: | 1.8.12-2.10.4
Installed tag: | 1.8.8-2.10.0
Scenes: | BunchPattern
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.8.8-2.10.0) does not match tags mentioned in the deployment ([‘1.8.12-2.10.4’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.12-2.10.4

Created: | 2021-05-05T10:20:05.000Z
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-21T14:09:17.000Z
Author: | Alessandro Silenzi
Notes: | FIX: cast delay to integer to comply with Karabo 2.11

1.8.10-2.10.2

Created: | 2021-02-10T14:47:03.000Z
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-12T12:38:56.000Z
Author: | Andrea Parenti
Notes: | Summary: * FEATURE inject runtime properties; * FIX initialization of DoocsOpticalDelay.

1.8.8-2.10.0

Created: | 2020-11-24T07:05:35.000Z
Author: | Steffen Hauf
Notes: |

1.8.7-2.9.4

Created: | 2020-11-12T15:46:42.000Z
Author: | Riccardo Fabbri
Notes: | Authorization to write to DOOCS retrieved at property level

1.8.6-2.9.4-fxe-xgmd

Created: | 2020-10-09T14:11:02.000Z
Author: | ehsanw
Notes: | to be used for fxe-xgmd

1.8.6-2.9.4

Created: | 2020-10-07T05:37:53.000Z
Author: | Steffen Hauf
Notes: | Add laser steering to bunch pattern pulser

1.8.5-2.9.1-xgm-log-timestamps

Created: | 2020-09-24T18:09:47.000Z
Author: | ehsanw
Notes: | Added timestamp and train id logging for xgm

1.8.5-2.9.1

Created: | 2020-09-15T07:18:47.000Z
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-02T07:35:59.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Description field added to the table.

1.8.3-2.9.1

Created: | 2020-08-26T10:18:01.000Z
Author: | Wajid Ehsan
Notes: | Bunch Arrival Monitor new parameters

1.8.2-2.9.1

Created: | 2020-08-26T09:20:59.000Z
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-21T11:49:45.000Z
Author: | Steffen Hauf
Notes: | Updates for the bunch pattern pulse

1.8.0-2.9.1-sqs-pattern-delay

Created: | 2020-08-20T12:42:42.000Z
Author: | bondarv
Notes: | For tests only. X2Timer in SQS with additional expected parameter “bunchPatternDelay”

1.8.0-2.9.1

Created: | 2020-08-07T15:10:21.000Z
Author: | Steffen Hauf
Notes: | Add the DoocsMirror device

1.7.0-2.9.1

Created: | 2020-08-05T09:24:35.000Z
Author: | Steffen Hauf
Notes: | Add BunchPatternPulser Device

1.6.7-2.9.1

Created: | 2020-08-04T16:57:39.000Z
Author: | mamchykd
Notes: | Updates for DoocsUndulatorCells device (fix for a proper xml structure and calculation of lastClosedUndulator property value). The tag is ok for deployment

1.6.6-2.9.1-sqs

Created: | 2020-07-24T15:49:52.000Z
Author: | mamchykd
Notes: | Tag from branch (SQS-only). Shortened version of with reduced DoocsXGM properties for SQS

1.6.5-2.9.1

Created: | 2020-07-15T05:47:01.000Z
Author: | Steffen Hauf
Notes: | DoocsUndulatorCells device restored. The tag is ok for deployment

### SYS

[add component documentation]

#### VAC2MPS

[add component documentation]

##### SWITCH

[add component documentation]

###### SA1_VAC_OK_state

Instance id: | SA1_SYS_VAC2MPS/SWITCH/SA1_VAC_OK_state
Host: | exflcon36n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-01
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T13:04:48.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[add instance documentation]

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

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: |

### XTD2

[add component documentation]

#### DOOCS

[add component documentation]

##### BAM

[add component documentation]

###### LCAT414_B2

###### LCAT1932M_TL

###### LCAT1932S_TL

#### XGM

###### DOOCS

Instance id: | SA1_XTD2_XGM/XGM/DOOCS
Class id: | DoocsXGM
Host: | spb-rr-sys-con-06
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/doocsDevices
Last modified: | 2021-06-15T11:00:23.000+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Hauf, Parenti
Latest tag: | 1.8.14-2.11.1
Deployment tag: | 1.8.14-2.11.1
Installed tag: | 1.8.12-2.10.4
Projects: | DOOCS, MAIN_copy
Scenes: | XGM_intensities, SA1_XTD2_XGM, SA1_XTD2_XGM_OVERVIEW, XGM_intensities, SA1_XTD2_XGM, SA1_Beam_Conditions, XTD2_XGM_Overview, XTD2_XGM_Overview
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.8.12-2.10.4) does not match tags mentioned in the deployment ([‘1.8.14-2.11.1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reconnectInterval:
    Reconnect Interval to DOOCS in case of ERROR
- reset:
    Resets the device in case of an error
- location:
    Location identifies DOOCS server like XGM.2643.T9
- pollingInterval:
    Polling Interval to get updated values from DOOCS.
- controlData:
    Slow data parameters

Release History
1.8.14-2.11.1

Created: | 2021-06-08T13:36:50.000Z
Author: | Gabriele Giovanetti
Notes: | fix DEPENDS

1.8.13-2.11.1

Created: | 2021-05-19T12:26:44.000Z
Author: | Steffen Hauf
Notes: | Merge branch ‘feat/mirror_scene’ into ‘master’

1.8.12-2.10.4

Created: | 2021-05-05T10:20:05.000Z
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-21T14:09:17.000Z
Author: | Alessandro Silenzi
Notes: | FIX: cast delay to integer to comply with Karabo 2.11

1.8.10-2.10.2

Created: | 2021-02-10T14:47:03.000Z
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-12T12:38:56.000Z
Author: | Andrea Parenti
Notes: | Summary: * FEATURE inject runtime properties; * FIX initialization of DoocsOpticalDelay.

1.8.8-2.10.0

Created: | 2020-11-24T07:05:35.000Z
Author: | Steffen Hauf
Notes: |

1.8.7-2.9.4

Created: | 2020-11-12T15:46:42.000Z
Author: | Riccardo Fabbri
Notes: | Authorization to write to DOOCS retrieved at property level

1.8.6-2.9.4-fxe-xgmd

Created: | 2020-10-09T14:11:02.000Z
Author: | ehsanw
Notes: | to be used for fxe-xgmd

1.8.6-2.9.4

Created: | 2020-10-07T05:37:53.000Z
Author: | Steffen Hauf
Notes: | Add laser steering to bunch pattern pulser

1.8.5-2.9.1-xgm-log-timestamps

Created: | 2020-09-24T18:09:47.000Z
Author: | ehsanw
Notes: | Added timestamp and train id logging for xgm

1.8.5-2.9.1

Created: | 2020-09-15T07:18:47.000Z
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-02T07:35:59.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Description field added to the table.

1.8.3-2.9.1

Created: | 2020-08-26T10:18:01.000Z
Author: | Wajid Ehsan
Notes: | Bunch Arrival Monitor new parameters

1.8.2-2.9.1

Created: | 2020-08-26T09:20:59.000Z
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-21T11:49:45.000Z
Author: | Steffen Hauf
Notes: | Updates for the bunch pattern pulse

1.8.0-2.9.1-sqs-pattern-delay

Created: | 2020-08-20T12:42:42.000Z
Author: | bondarv
Notes: | For tests only. X2Timer in SQS with additional expected parameter “bunchPatternDelay”

1.8.0-2.9.1

Created: | 2020-08-07T15:10:21.000Z
Author: | Steffen Hauf
Notes: | Add the DoocsMirror device

1.7.0-2.9.1

Created: | 2020-08-05T09:24:35.000Z
Author: | Steffen Hauf
Notes: | Add BunchPatternPulser Device

1.6.7-2.9.1

Created: | 2020-08-04T16:57:39.000Z
Author: | mamchykd
Notes: | Updates for DoocsUndulatorCells device (fix for a proper xml structure and calculation of lastClosedUndulator property value). The tag is ok for deployment

#### ATT

##### MDL

###### MAIN

#### MIRR-1

##### MOTOR

###### HMRX

Instance id: | SA1_XTD2_MIRR-1/MOTOR/HMRX
Class id: | BeckhoffSimpleMotor
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- 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.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

###### HMRY

Instance id: | SA1_XTD2_MIRR-1/MOTOR/HMRY
Class id: | BeckhoffSimpleMotor
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- 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.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

###### HMRZ

Instance id: | SA1_XTD2_MIRR-1/MOTOR/HMRZ
Class id: | BeckhoffSimpleMotor
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- 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.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

###### HMTX

Instance id: | SA1_XTD2_MIRR-1/MOTOR/HMTX
Class id: | BeckhoffSimpleMotor
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- 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.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

###### HMTY

Instance id: | SA1_XTD2_MIRR-1/MOTOR/HMTY
Class id: | BeckhoffSimpleMotor
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- 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.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

#### MIRR-2

##### MOTOR

###### HMRX

Instance id: | SA1_XTD2_MIRR-2/MOTOR/HMRX
Class id: | BeckhoffSimpleMotor
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- 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.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

###### HMRY

Instance id: | SA1_XTD2_MIRR-2/MOTOR/HMRY
Class id: | BeckhoffSimpleMotor
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- 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.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

###### HMRZ

Instance id: | SA1_XTD2_MIRR-2/MOTOR/HMRZ
Class id: | BeckhoffSimpleMotor
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- 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.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

###### HMTX

Instance id: | SA1_XTD2_MIRR-2/MOTOR/HMTX
Class id: | BeckhoffSimpleMotor
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- 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.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

###### HMTY

Instance id: | SA1_XTD2_MIRR-2/MOTOR/HMTY
Class id: | BeckhoffSimpleMotor
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- 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.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

###### BENDER

Instance id: | SA1_XTD2_MIRR-2/MOTOR/BENDER
Class id: | BeckhoffSimpleMotor
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- interfaces:
    Abstract interface for external proxies to be considered when working with this device
- 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.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

##### ACTRL

[add component documentation]

###### RY

Instance id: | SA1_XTD2_MIRR-2/ACTRL/RY
Class id: | BeckhoffAnalogOutput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-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

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog 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

###### RZ

Instance id: | SA1_XTD2_MIRR-2/ACTRL/RZ
Class id: | BeckhoffAnalogOutput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-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

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog 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]

###### RY

Instance id: | SA1_XTD2_MIRR-2/ASENS/RY
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.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

###### RZ

Instance id: | SA1_XTD2_MIRR-2/ASENS/RZ
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

Release History
4.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

### SRP

[add component documentation]

#### AIBS

[add component documentation]

##### AIBS

[add component documentation]

###### SPB_AIBS

## SPB

[add component documentation]

### XTD9

[add component documentation]

#### VAC

[add component documentation]

##### SWITCH

[add component documentation]

###### SHUT_open

Instance id: | SPB_XTD9_VAC/SWITCH/SHUT_open
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-01
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-01
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.4-2.11.1
Scenes: | Instrument-Overview-Long, MPS-SPB_VALVES_OPEN, Instrument-Overview-Long-NoCRL, SPB_SYS_VAC2MPS_DCTRL_SPB_VALVES_OPEN_INTERLOCK, SPB-Mode-1-overview-RB, SPB Mode M overview-RB0, SPB Mode 1 overview, Instrument-Overview-Long-IRDa, SPB Mode S overview, SPB Mode M overview, MPS-SPB_VALVES_OPEN, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T09:55:43.000Z
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

###### SHUT_aclose

Instance id: | SPB_XTD9_VAC/SWITCH/SHUT_aclose
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-01
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-01
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.4-2.11.1
Scenes: | MPS-SPB_VALVES_OPEN, SPB_SYS_VAC2MPS_DCTRL_SPB_VALVES_OPEN_INTERLOCK, Shift_End_Checks, Shift_End_Checks, Shift_End_Checks_HOME, MPS-MODE_1, MPS-MODE_S, MPS-MODE_M, MPS-SPB_VALVES_OPEN, MPS-MODE_1, MPS-MODE_S, MPS-MODE_M
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T09:55:43.000Z
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

#### ATT

[add component documentation]

##### TSENS

[add component documentation]

###### ARM4_TB

Instance id: | SPB_XTD9_ATT/TSENS/ARM4_TB
Class id: | BeckhoffAnalogInput
Host: | exflcon53n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | tsensors, tsensors, tsensors
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’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### APERTURE_TA

Instance id: | SPB_XTD9_ATT/TSENS/APERTURE_TA
Class id: | BeckhoffAnalogInput
Host: | exflcon53n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | tsensors, tsensors, tsensors
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’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### APERTURE_TB

Instance id: | SPB_XTD9_ATT/TSENS/APERTURE_TB
Class id: | BeckhoffAnalogInput
Host: | exflcon53n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | tsensors, tsensors, tsensors
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’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM1_TA

Instance id: | SPB_XTD9_ATT/TSENS/ARM1_TA
Class id: | BeckhoffAnalogInput
Host: | exflcon53n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | tsensors, tsensors, tsensors
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’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM1_TB

Instance id: | SPB_XTD9_ATT/TSENS/ARM1_TB
Class id: | BeckhoffAnalogInput
Host: | exflcon53n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | tsensors, tsensors, tsensors
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’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM2_TA

Instance id: | SPB_XTD9_ATT/TSENS/ARM2_TA
Class id: | BeckhoffAnalogInput
Host: | exflcon53n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | tsensors, tsensors, tsensors
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’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM2_TB

Instance id: | SPB_XTD9_ATT/TSENS/ARM2_TB
Class id: | BeckhoffAnalogInput
Host: | exflcon53n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | tsensors, tsensors, tsensors
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’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM3_TA

Instance id: | SPB_XTD9_ATT/TSENS/ARM3_TA
Class id: | BeckhoffAnalogInput
Host: | exflcon53n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | tsensors, tsensors, tsensors
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’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM3_TB

Instance id: | SPB_XTD9_ATT/TSENS/ARM3_TB
Class id: | BeckhoffAnalogInput
Host: | exflcon53n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | tsensors, tsensors, tsensors
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’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM4_TA

Instance id: | SPB_XTD9_ATT/TSENS/ARM4_TA
Class id: | BeckhoffAnalogInput
Host: | exflcon53n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | tsensors, tsensors, tsensors
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’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

##### DCTRL

[add component documentation]

###### ARM4_LIMITL

Instance id: | SPB_XTD9_ATT/DCTRL/ARM4_LIMITL
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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

###### ARM1_LIMITL

Instance id: | SPB_XTD9_ATT/DCTRL/ARM1_LIMITL
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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

###### ARM2_LIMITL

Instance id: | SPB_XTD9_ATT/DCTRL/ARM2_LIMITL
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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

###### ARM3_LIMITL

Instance id: | SPB_XTD9_ATT/DCTRL/ARM3_LIMITL
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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

##### MDL

[add component documentation]

###### MAIN

Instance id: | SPB_XTD9_ATT/MDL/MAIN
Class id: | JJAttenuator
Host: | spb-rr-sys-con-01
Class documentation:
| JJAttenuator
Alias: | spb-rr-sys-con-01
Git repo: | https://git.xfel.eu/gitlab/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: | Attenuator, Attenuator, attenuator, Attenuator, Attenuator, Attenuator, Attenuator, Shift_End_Checks, XTD9_Attenuator, desiredTransmission, IRU_D12_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!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock 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-20T10:32:15.000Z
Author: | Alessandro Silenzi
Notes: | Use async/await syntax

2.5.2-2.10.0

Created: | 2021-02-05T12:32:28.000Z
Author: | Wajid Ehsan
Notes: | Protection of SI filters in ATT stacks

2.5.1-2.10.0

Created: | 2020-11-23T10:02:21.000Z
Author: | Andrea Parenti
Notes: | Summary: add CI

2.5.0-2.10.0

Created: | 2020-11-19T14:38:10.000Z
Author: | Dennis Goeries
Notes: |

2.4.0-2.6.1

Created: | 2019-02-12T12:41:03.000Z
Author: | xctrl
Notes: |

2.4.0.post2-2.2.6

Created: | 2018-11-07T17:18:58.000Z
Author: | silenzi
Notes: | This version will be loadable from a 2.2 system

2.4.0-2.3.0

Created: | 2018-10-23T16:08:33.000Z
Author: | Alessandro Silenzi
Notes: |

2.3.1-2.2.4

Created: | 2018-07-31T14:24:49.000Z
Author: | Dennis Goeries
Notes: |

2.3.0-2.2.4

Created: | 2018-06-13T13:51:20.000Z
Author: | Dennis Goeries
Notes: |

2.2.2-2.2.3

Created: | 2018-05-03T12:37:48.000Z
Author: | Dennis Goeries
Notes: |

2.2.1-2.2.3

Created: | 2018-04-27T09:01:33.000Z
Author: | Dennis Goeries
Notes: |

2.2.0-2.2.3

Created: | 2018-04-18T15:39:22.000Z
Author: | Dennis Goeries
Notes: |

2.1.0-2.2.0

Created: | 2017-12-15T16:44:24.000Z
Author: | Dennis Goeries
Notes: |

2.0.7-2.1.14

Created: | 2017-09-11T15:37:46.000Z
Author: | Dennis Goeries
Notes: |

2.0.6-2.1.14

Created: | 2017-09-04T16:00:19.000Z
Author: | Dennis Goeries
Notes: |

2.0.5-2.1.14

Created: | 2017-08-18T14:30:01.000Z
Author: | Dennis Goeries
Notes: |

2.0.4-2.1.14

Created: | 2017-08-16T15:34:40.000Z
Author: | Dennis Goeries
Notes: |

2.0.3-2.1.12

Created: | 2017-07-21T15:30:30.000Z
Author: | Dennis Goeries
Notes: |

2.0.2-2.1

Created: | 2017-07-05T15:31:01.000Z
Author: | Dennis Goeries
Notes: |

##### MOTOR

[add component documentation]

###### CHAMY

###### ARM1

###### ARM2

###### ARM3

###### ARM4

###### CHAMX

#### CRL

[add component documentation]

##### DCTRL

[add component documentation]

###### LENS9_Y_LIMITL

Instance id: | SPB_XTD9_CRL/DCTRL/LENS9_Y_LIMITL
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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

###### LENS10_Y_LIMITL

Instance id: | SPB_XTD9_CRL/DCTRL/LENS10_Y_LIMITL
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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

###### LENS1_Y_LIMITL

Instance id: | SPB_XTD9_CRL/DCTRL/LENS1_Y_LIMITL
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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

###### LENS2_Y_LIMITL

Instance id: | SPB_XTD9_CRL/DCTRL/LENS2_Y_LIMITL
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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

###### LENS3_Y_LIMITL

Instance id: | SPB_XTD9_CRL/DCTRL/LENS3_Y_LIMITL
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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

###### LENS4_Y_LIMITL

Instance id: | SPB_XTD9_CRL/DCTRL/LENS4_Y_LIMITL
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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

###### LENS5_Y_LIMITL

Instance id: | SPB_XTD9_CRL/DCTRL/LENS5_Y_LIMITL
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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

###### LENS6_Y_LIMITL

Instance id: | SPB_XTD9_CRL/DCTRL/LENS6_Y_LIMITL
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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

###### LENS7_Y_LIMITL

Instance id: | SPB_XTD9_CRL/DCTRL/LENS7_Y_LIMITL
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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

###### LENS8_Y_LIMITL

Instance id: | SPB_XTD9_CRL/DCTRL/LENS8_Y_LIMITL
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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

#### PPU

[add component documentation]

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

##### TSYS

[add component documentation]

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

###### PPU

Instance id: | SPB_XTD9_PPU/TSYS/PPU
Class id: | X2TimerML
Host: | spb-rr-sys-con-06
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2021-05-07T16:06:25.000+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.0-2.10.4
Deployment tag: | 1.4.0-2.10.4
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.0-2.10.4

Created: | 2021-05-07T14:01:37.000Z
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

##### CAM

[add component documentation]

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

###### CAMERA

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

##### DCTRL

[add component documentation]

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

###### TRIG

Instance id: | SPB_XTD9_PPU/DCTRL/TRIG
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | PPU_Barrier, SPB_PPU_Barrier, PICKY-TEST
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’])!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.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

###### BARRIER1_2_RX_PWR

Instance id: | SPB_XTD9_PPU/DCTRL/BARRIER1_2_RX_PWR
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | PPU_Barrier, XTD9_PPU, SPB_PPU_Barrier, SPB_XTD9_PPU, SPB_XTD9_PPU, SPB_PPU_Barrier, SPB_XTD9_PPU, SPB_PPU_Barrier
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’])!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.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

###### BARRIERS

Instance id: | SPB_XTD9_PPU/DCTRL/BARRIERS
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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’])!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.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

###### CAMERA

Instance id: | SPB_XTD9_PPU/DCTRL/CAMERA
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | XTD9_PPU, SPB_XTD9_IMGPI, Ptychography, SPB_XTD9_PPU, SPB_XTD9_PPU, SPB_XTD9_PPU
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’])!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.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

###### LED

Instance id: | SPB_XTD9_PPU/DCTRL/LED
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | CamOverview, XTD9_PPU, CamOverview, SPB_XTD9_IMGPI, CamOverview, Ptychography, SPB_XTD9_PPU, SPB_XTD9_PPU, SPB_XTD9_PPU
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’])!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.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

###### STEP1

Instance id: | SPB_XTD9_PPU/DCTRL/STEP1
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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’])!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.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

###### STEP2

Instance id: | SPB_XTD9_PPU/DCTRL/STEP2
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | PICKY-TEST
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’])!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.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

##### ENC

[add component documentation]

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

###### ROTOR

Instance id: | SPB_XTD9_PPU/ENC/ROTOR
Class id: | BeckhoffEncoder
Host: | exflcon53n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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’])!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- 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.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

##### MDL

[add component documentation]

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

###### TRIGGER

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

###### BW_AVG

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

##### MOTOR

[add component documentation]

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

###### ROTOR

Instance id: | SPB_XTD9_PPU/MOTOR/ROTOR
Class id: | BeckhoffSimpleMotor
Host: | exflcon53n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | PPU_Barrier, XTD9_PPU, SPB_PPU_Barrier, Ptychography, SPB_XTD9_PPU, SPB_XTD9_PPU, SPB_PPU_Barrier, SPB_XTD9_PPU, SPB_PPU_Barrier
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’])!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

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.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

##### PROC

[add component documentation]

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

###### IMPROC

Instance id: | SPB_XTD9_PPU/PROC/IMPROC
Class id: | ImageProcessor
Host: | spb-rr-sys-con-spc
Class documentation:
| ImageProcessor
Alias: | spb-rr-sys-con-spc
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
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!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

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.

###### IMPICK

Instance id: | SPB_XTD9_PPU/PROC/IMPICK
Class id: | ImagePicker
Host: | spb-rr-sys-con-spc
Alias: | spb-rr-sys-con-spc
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: | PP-SCAN-TEST
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!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

Image Picker

The `ImagePicker` device is part of the imageProcessor package, and is documented in imageprocessor:image-picker-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.
- isDisabled:
    When disabled, all images received in input areforwarded to output channel.
- outFrameRate:
    The output frame rate.
- trainIdOffset:
    Positive: output image train ID is greater than input train ID (delay). Negative: output image train ID is lower than input train (advance)
- imgBufferSize:
    Number of images to be kept waiting for a matching train ID.
- trainIdBufferSize:
    Number of train IDs to be kept waiting for an image with matching train ID.

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

[add component documentation]

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

###### TRIG_SIGNAL

Instance id: | SPB_XTD9_PPU/SWITCH/TRIG_SIGNAL
Class id: | BeckhoffDigitalInput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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’])!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware 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.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

###### BARRIER1_RX

Instance id: | SPB_XTD9_PPU/SWITCH/BARRIER1_RX
Class id: | BeckhoffDigitalInput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | XTD9_PPU, SPB_XTD9_PPU, SPB_XTD9_PPU
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’])!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware 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.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

###### BARRIER2_RX

Instance id: | SPB_XTD9_PPU/SWITCH/BARRIER2_RX
Class id: | BeckhoffDigitalInput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | XTD9_PPU, SPB_XTD9_PPU, SPB_XTD9_PPU
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’])!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware 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.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

##### TEMP

[add component documentation]

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

###### IRTHERMO_PWR

Instance id: | SPB_XTD9_PPU/TEMP/IRTHERMO_PWR
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | XTD9_PPU, SPB_XTD9_PPU, SPB_XTD9_PPU, SPB_XTD9_PPU
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’])!

General documentation for the pulse picker can be found here.

The middlelayer device is documented here.

Note

Documentation is written for the SPB pulse picker instance, but should mostly be generally applicable.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles

Release History
4.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

#### SCR

[add component documentation]

##### TSYS

[add component documentation]

###### TRIG

Instance id: | SPB_XTD9_SCR/TSYS/TRIG
Class id: | X2TimerML
Host: | spb-rr-sys-con-06
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2021-05-07T16:06:25.000+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.0-2.10.4
Deployment tag: | 1.4.0-2.10.4
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.0-2.10.4

Created: | 2021-05-07T14:01:37.000Z
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

##### CAM

[add component documentation]

###### CAMERA

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

##### DCTRL

[add component documentation]

###### LED

###### CAMERA_FAN

Instance id: | SPB_XTD9_SCR/DCTRL/CAMERA_FAN
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | SPB_XTD9_SCR, SPB_XTD9_SCR, SPB_XTD9_SCR, SPB_XTD9_SCR, SPB_XTD9_SCR, SPB_XTD9_SCR, SPB_XTD9_SCR, XTD9_SCR
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

###### CAMERA_POWER

Instance id: | SPB_XTD9_SCR/DCTRL/CAMERA_POWER
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | SPB_XTD9_SCR, SPB_XTD9_SCR, SPB_XTD9_SCR, SPB_XTD9_SCR, SPB_XTD9_SCR, SPB_XTD9_SCR, SPB_XTD9_SCR, XTD9_SCR
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

###### HOLSTER_X_LIMITL

Instance id: | SPB_XTD9_SCR/DCTRL/HOLSTER_X_LIMITL
Class id: | BeckhoffDigitalOutput
Host: | exflcon53n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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

##### MDL

[add component documentation]

###### BIU

Instance id: | SPB_XTD9_SCR/MDL/BIU
Class id: | BeamImagingUnit
Host: | spb-rr-sys-con-16
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2021-05-21T17:41:00.000+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Costa, Goeries
Latest tag: | 1.3.7-2.11.0
Deployment tag: | 1.3.7-2.11.0
Installed tag: | 1.3.7-2.11.0
Scenes: | Screen_Overview, CamOverview, CamOverview, XTD9_SCR, XTD9_SCR_AVG
Accessible by: | 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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveSCR_in:
    Moves the motor to the position marked with this label
- moveSCR_out:
    Moves the motor to the position marked with this label

Release History
1.3.7-2.11.0

Created: | 2021-05-20T15:44:30.000Z
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T13:56:25.000Z
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T14:53:29.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

##### MOTOR

[add component documentation]

###### HOLSTER_X

##### TSENS

[add component documentation]

###### CAMERA

Instance id: | SPB_XTD9_SCR/TSENS/CAMERA
Class id: | BeckhoffAnalogInput
Host: | exflcon53n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-br-sys-con-tunnel
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
Scenes: | SPB_XTD9_SCR, SPB_XTD9_SCR, tempTest, SPB_XTD9_SCR, SPB_XTD9_SCR, SPB_XTD9_SCR, tsensors, tsensors, tempTest, SPB_XTD9_SCR, SPB_XTD9_SCR, XTD9_SCR, tsensors, tempTest
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’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

##### PROC

[add component documentation]

###### AVG

Instance id: | SPB_XTD9_SCR/PROC/AVG
Class id: | ImageAverager
Host: | spb-rr-sys-con-spc
Alias: | spb-rr-sys-con-spc
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: | XTD9_SCR_AVG
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.

#### SHUT

[add component documentation]

##### SWITCH

[add component documentation]

###### CLOSE

Instance id: | SPB_XTD9_SHUT/SWITCH/CLOSE
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-01
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-01
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

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

#### XGM

###### DOOCS

Instance id: | SPB_XTD9_XGM/XGM/DOOCS
Class id: | DoocsXGM
Host: | spb-rr-sys-con-06
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/doocsDevices
Last modified: | 2021-06-15T11:00:23.000+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Hauf, Parenti
Latest tag: | 1.8.14-2.11.1
Deployment tag: | 1.8.14-2.11.1
Installed tag: | 1.8.12-2.10.4
Projects: | DOOCS, MAIN_copy
Scenes: | XGM_intensities, SPB_XTD9_XGM, SPB_XTD9_XGM_OVERVIEW, correlator, XGM_intensities, SPB_XTD9_XGM, correlator, SA1_Beam_Conditions, XTD9_XGM_Overview, IRU_D12_Overview
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.8.12-2.10.4) does not match tags mentioned in the deployment ([‘1.8.14-2.11.1’])!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reconnectInterval:
    Reconnect Interval to DOOCS in case of ERROR
- reset:
    Resets the device in case of an error
- location:
    Location identifies DOOCS server like XGM.2643.T9
- pollingInterval:
    Polling Interval to get updated values from DOOCS.
- controlData:
    Slow data parameters

Release History
1.8.14-2.11.1

Created: | 2021-06-08T13:36:50.000Z
Author: | Gabriele Giovanetti
Notes: | fix DEPENDS

1.8.13-2.11.1

Created: | 2021-05-19T12:26:44.000Z
Author: | Steffen Hauf
Notes: | Merge branch ‘feat/mirror_scene’ into ‘master’

1.8.12-2.10.4

Created: | 2021-05-05T10:20:05.000Z
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-21T14:09:17.000Z
Author: | Alessandro Silenzi
Notes: | FIX: cast delay to integer to comply with Karabo 2.11

1.8.10-2.10.2

Created: | 2021-02-10T14:47:03.000Z
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-12T12:38:56.000Z
Author: | Andrea Parenti
Notes: | Summary: * FEATURE inject runtime properties; * FIX initialization of DoocsOpticalDelay.

1.8.8-2.10.0

Created: | 2020-11-24T07:05:35.000Z
Author: | Steffen Hauf
Notes: |

1.8.7-2.9.4

Created: | 2020-11-12T15:46:42.000Z
Author: | Riccardo Fabbri
Notes: | Authorization to write to DOOCS retrieved at property level

1.8.6-2.9.4-fxe-xgmd

Created: | 2020-10-09T14:11:02.000Z
Author: | ehsanw
Notes: | to be used for fxe-xgmd

1.8.6-2.9.4

Created: | 2020-10-07T05:37:53.000Z
Author: | Steffen Hauf
Notes: | Add laser steering to bunch pattern pulser

1.8.5-2.9.1-xgm-log-timestamps

Created: | 2020-09-24T18:09:47.000Z
Author: | ehsanw
Notes: | Added timestamp and train id logging for xgm

1.8.5-2.9.1

Created: | 2020-09-15T07:18:47.000Z
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-02T07:35:59.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Description field added to the table.

1.8.3-2.9.1

Created: | 2020-08-26T10:18:01.000Z
Author: | Wajid Ehsan
Notes: | Bunch Arrival Monitor new parameters

1.8.2-2.9.1

Created: | 2020-08-26T09:20:59.000Z
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-21T11:49:45.000Z
Author: | Steffen Hauf
Notes: | Updates for the bunch pattern pulse

1.8.0-2.9.1-sqs-pattern-delay

Created: | 2020-08-20T12:42:42.000Z
Author: | bondarv
Notes: | For tests only. X2Timer in SQS with additional expected parameter “bunchPatternDelay”

1.8.0-2.9.1

Created: | 2020-08-07T15:10:21.000Z
Author: | Steffen Hauf
Notes: | Add the DoocsMirror device

1.7.0-2.9.1

Created: | 2020-08-05T09:24:35.000Z
Author: | Steffen Hauf
Notes: | Add BunchPatternPulser Device

1.6.7-2.9.1

Created: | 2020-08-04T16:57:39.000Z
Author: | mamchykd
Notes: | Updates for DoocsUndulatorCells device (fix for a proper xml structure and calculation of lastClosedUndulator property value). The tag is ok for deployment

### BIO

[add component documentation]

#### SYS

[add component documentation]

##### PUMP

[add component documentation]

###### HPLC

### CTRL

[add component documentation]

#### MPS

[add component documentation]

##### DCTRL

[add component documentation]

###### MODES_SHUTOFF

Instance id: | SPB_CTRL_MPS/DCTRL/MODES_SHUTOFF
Class id: | BeckhoffDigitalOutput
Host: | exflcon36n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-01
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: | Beam-OffSwitch, MPS-MODE_S
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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

###### BEAM_SHUTOFF

Instance id: | SPB_CTRL_MPS/DCTRL/BEAM_SHUTOFF
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-01
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-01
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.4-2.11.1
Scenes: | Beam-OffSwitch, MPS-MODE_1, MPS-MODE_S, MPS-MODE_1, MPS-MODE_S
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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

#### TOOLING

[add component documentation]

##### MDL

[add component documentation]

###### BECKHOFF_ASSISTANT

#### VERIFY

[add component documentation]

##### MDL

[add component documentation]

###### ARCHIVE

### DAQ

[add component documentation]

#### DATA

[add component documentation]

##### JNGFR

[add component documentation]

###### 8

Instance id: | SPB_DAQ_DATA/JNGFR/8
Class id: | DataAggregator
Host: | spb-br-sys-daq-da4
Alias: | spb-br-sys-daq-da4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Scenes: | SPB_RUN_CONTROL_2, SPB_DAQ_STATUS-OBSOLETE, SPB_RUN_CONTROL-OBSOLETE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### 2

Instance id: | SPB_DAQ_DATA/JNGFR/2
Class id: | DataAggregator
Host: | spb-br-sys-daq-da3
Alias: | spb-br-sys-daq-da3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Scenes: | SPB_RUN_CONTROL_2, SPB_DAQ_STATUS-OBSOLETE, SPB_RUN_CONTROL-OBSOLETE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### 3

Instance id: | SPB_DAQ_DATA/JNGFR/3
Class id: | DataAggregator
Host: | spb-br-sys-daq-da3
Alias: | spb-br-sys-daq-da3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Scenes: | SPB_RUN_CONTROL_2, SPB_DAQ_STATUS-OBSOLETE, SPB_RUN_CONTROL-OBSOLETE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### 7

Instance id: | SPB_DAQ_DATA/JNGFR/7
Class id: | DataAggregator
Host: | spb-br-sys-daq-da4
Alias: | spb-br-sys-daq-da4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Scenes: | SPB_RUN_CONTROL_2, SPB_DAQ_STATUS-OBSOLETE, SPB_RUN_CONTROL-OBSOLETE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### 4

Instance id: | SPB_DAQ_DATA/JNGFR/4
Class id: | DataAggregator
Host: | spb-br-sys-daq-da3
Alias: | spb-br-sys-daq-da3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Scenes: | SPB_DAQ_STATUS-OBSOLETE, SPB_RUN_CONTROL-OBSOLETE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### 5

Instance id: | SPB_DAQ_DATA/JNGFR/5
Class id: | DataAggregator
Host: | spb-br-sys-daq-da4
Alias: | spb-br-sys-daq-da4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Scenes: | SPB_DAQ_STATUS-OBSOLETE, SPB_RUN_CONTROL-OBSOLETE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

##### DA

[add component documentation]

###### 4

Instance id: | SPB_DAQ_DATA/DA/4
Class id: | DataAggregator
Host: | spb-br-sys-daq-da2
Alias: | spb-br-sys-daq-da2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Scenes: | SPB_RUN_CONTROL_2, agipd_overview, SPB_DAQ_STATUS-OBSOLETE, SPB_RUN_CONTROL-OBSOLETE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### 2

Instance id: | SPB_DAQ_DATA/DA/2
Class id: | DataAggregator
Host: | spb-br-sys-daq-da2
Alias: | spb-br-sys-daq-da2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Projects: | SPB_DAQ, SPB_RUN_MANAGEMENT, CAMERAs, MAIN_copy
Scenes: | SPB_DAQ_STATUS, SPB_RUN_CONTROL, SPB_RUN_CONTROL_2, agipd_overview, SPB_DAQ_STATUS-OBSOLETE, agipd_overview, SPB_RUN_CONTROL-OBSOLETE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### 3

Instance id: | SPB_DAQ_DATA/DA/3
Class id: | DataAggregator
Host: | spb-br-sys-daq-da1
Alias: | spb-br-sys-daq-da1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Scenes: | SPB_RUN_CONTROL_2, agipd_overview, SPB_DAQ_STATUS-OBSOLETE, SPB_RUN_CONTROL-OBSOLETE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

##### DM

[add component documentation]

###### checkConfigGroups

Instance id: | SPB_DAQ_DATA/DM/checkConfigGroups
Class id: | CheckConfigGroups
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/checkConfigGroups
Last modified: | 2021-06-28T21:46:43.000+02:00
Created at: | 2018-03-13T18:16:19.000+01:00
Main authors: | Maia, Haufs, Tirumalai
Latest tag: | 2.2.1-2.5.0
Deployment tag: | 2.2.1-2.5.0
Scenes: | CHECK_COFIGURATION_GROUPS, EMAIL_COFIGURATION_GROUPS
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock 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.1-2.5.0

Created: | 2021-06-28T19:45:57.000Z
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0-test2

Created: | 2021-06-09T12:34:36.000Z
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0

Created: | 2021-06-09T12:34:36.000Z
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0-test

Created: | 2021-06-03T15:02:14.000Z
Author: | Parthasarathy Tirumalai
Notes: |

2.1.0-2.5.0

Created: | 2019-07-02T14:39:58.000Z
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-17T15:54:16.000Z
Author: | Luis Maia
Notes: | Release tag 2.0.8.1-2.4.0

2.0.9-2.4.0

Created: | 2019-04-01T08:08:53.000Z
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-31T16:58:06.000Z
Author: | Parthasarathy Tirumalai
Notes: | Release tag 2.0.8-2.3.0

2.0.7-2.3.0

Created: | 2019-01-31T11:36:28.000Z
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-28T15:23:50.000Z
Author: | Nasser Al-Qudami
Notes: | This tag includes bugs fix.

2.0.5-2.3.2

Created: | 2019-01-25T09:40:18.000Z
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-22T13:51:35.000Z
Author: | Luis Maia
Notes: | Release tag 2.0.4

2.0.3-2.2.3

Created: | 2018-05-03T12:55:29.000Z
Author: | Luis Maia
Notes: | Release tag 2.0.3-2.2.3

2.0.2-2.2.3

Created: | 2018-04-24T23:22:08.000Z
Author: | Luis Maia
Notes: | Release tag 2.0.2-2.2.3

2.0.1-2.2.3

Created: | 2018-04-23T21:00:46.000Z
Author: | Luis Maia
Notes: | Release tag 2.0.1-2.2.3

2.0.0-2.2.3

Created: | 2018-04-18T14:17:44.000Z
Author: | Luis Maia
Notes: | Release tag 2.0.0-2.2.3

1.1.4-2.2.2

Created: | 2018-03-29T09:43:32.000Z
Author: | Nasser Al-Qudami
Notes: |

1.1.3-2.2.2

Created: | 2018-03-29T09:36:38.000Z
Author: | Nasser Al-Qudami
Notes: |

1.1.2-2.2.2

Created: | 2018-03-29T09:31:23.000Z
Author: | Nasser Al-Qudami
Notes: |

1.1.1-2.2.2

Created: | 2018-03-29T09:23:50.000Z
Author: | Nasser Al-Qudami
Notes: |

###### AGIPD1M_XTDF_GROUP

Instance id: | SPB_DAQ_DATA/DM/AGIPD1M_XTDF_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### AGIPD_MOTORS_GROUP

Instance id: | SPB_DAQ_DATA/DM/AGIPD_MOTORS_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Scenes: | SPB_DAQ_DATA/DM/AGIPD_MOTORS_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### CONFIGURATOR

Instance id: | SPB_DAQ_DATA/DM/CONFIGURATOR
Class id: | RunConfigurator
Host: | spb-br-sys-daq-srv1
Alias: | spb-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Projects: | SPB_RUN_MANAGEMENT, CAMERAs, MAIN_copy, SPB_TEST_DAQ_SLOW_DATA
Scenes: | SPB_RUN_CONTROL, Run Control (v2), SPB_DAQ_DATA/DM/CONFIGURATOR|scene, SPB_RUN_CONTROL_2, SPB_RUN_CONTROL_2-OBSOLETE, Run Control (v2), SPB_RUN_CONFIGURATOR, SPB_DAQ_DATA/DM/CONFIGURATOR|scene, SPB_DAQ_DATA/DM/CONFIGURATOR|scene, SPB_RUN_CONTROL-OBSOLETE, SPB_RUN_CONTROL_GLOBAL_STATE, Run_Controller_Basic, SPB_RUN_CONTROL_2_GLOBAL_STATE, AGIPD_Monitoring_Run_Control, DAQ_Configuration_Helper, AGIPD_MONITORING_RUN_CONTROL_2_GLOBAL_STATE, Run_Controller
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### CONFIGURATOR_2

Instance id: | SPB_DAQ_DATA/DM/CONFIGURATOR_2
Class id: | RunConfigurator
Host: | spb-br-sys-daq-srv1
Alias: | spb-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Scenes: | SPB_RUN_CONTROL_2, SPB_RUN_CONTROL_2-OBSOLETE, SPB_RUN_CONTROL_2_GLOBAL_STATE, AGIPD_Monitoring_Run_Control, AGIPD_MONITORING_RUN_CONTROL_2_GLOBAL_STATE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### DATA_MANAGER

Instance id: | SPB_DAQ_DATA/DM/DATA_MANAGER
Class id: | DataManager
Host: | spb-br-sys-daq-srv1
Alias: | spb-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Projects: | SPB_TEST_DAQ_SLOW_DATA, SPB_RUN_MANAGEMENT, CAMERAs, MAIN_copy
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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
- 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### DSG_REPORT_1

Instance id: | SPB_DAQ_DATA/DM/DSG_REPORT_1
Class id: | ReportConfigGroups
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/checkConfigGroups
Last modified: | 2021-06-28T21:46:43.000+02:00
Created at: | 2018-03-13T18:16:19.000+01:00
Main authors: | Maia, Haufs, Tirumalai
Latest tag: | 2.2.1-2.5.0
Deployment tag: | 2.2.1-2.5.0
Scenes: | EMAIL_COFIGURATION_GROUPS
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- 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.1-2.5.0

Created: | 2021-06-28T19:45:57.000Z
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0-test2

Created: | 2021-06-09T12:34:36.000Z
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0

Created: | 2021-06-09T12:34:36.000Z
Author: | Parthasarathy Tirumalai
Notes: |

2.2.0-2.5.0-test

Created: | 2021-06-03T15:02:14.000Z
Author: | Parthasarathy Tirumalai
Notes: |

2.1.0-2.5.0

Created: | 2019-07-02T14:39:58.000Z
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-17T15:54:16.000Z
Author: | Luis Maia
Notes: | Release tag 2.0.8.1-2.4.0

2.0.9-2.4.0

Created: | 2019-04-01T08:08:53.000Z
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-31T16:58:06.000Z
Author: | Parthasarathy Tirumalai
Notes: | Release tag 2.0.8-2.3.0

2.0.7-2.3.0

Created: | 2019-01-31T11:36:28.000Z
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-28T15:23:50.000Z
Author: | Nasser Al-Qudami
Notes: | This tag includes bugs fix.

2.0.5-2.3.2

Created: | 2019-01-25T09:40:18.000Z
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-22T13:51:35.000Z
Author: | Luis Maia
Notes: | Release tag 2.0.4

2.0.3-2.2.3

Created: | 2018-05-03T12:55:29.000Z
Author: | Luis Maia
Notes: | Release tag 2.0.3-2.2.3

2.0.2-2.2.3

Created: | 2018-04-24T23:22:08.000Z
Author: | Luis Maia
Notes: | Release tag 2.0.2-2.2.3

2.0.1-2.2.3

Created: | 2018-04-23T21:00:46.000Z
Author: | Luis Maia
Notes: | Release tag 2.0.1-2.2.3

2.0.0-2.2.3

Created: | 2018-04-18T14:17:44.000Z
Author: | Luis Maia
Notes: | Release tag 2.0.0-2.2.3

1.1.4-2.2.2

Created: | 2018-03-29T09:43:32.000Z
Author: | Nasser Al-Qudami
Notes: |

1.1.3-2.2.2

Created: | 2018-03-29T09:36:38.000Z
Author: | Nasser Al-Qudami
Notes: |

1.1.2-2.2.2

Created: | 2018-03-29T09:31:23.000Z
Author: | Nasser Al-Qudami
Notes: |

1.1.1-2.2.2

Created: | 2018-03-29T09:23:50.000Z
Author: | Nasser Al-Qudami
Notes: |

###### EB_COND_GROUP

Instance id: | SPB_DAQ_DATA/DM/EB_COND_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### IRU_MOTORS_GROUP

Instance id: | SPB_DAQ_DATA/DM/IRU_MOTORS_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Scenes: | SPB_DAQ_DATA/DM/IRU_MOTORS_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### IRU_MOTORS_SACT_GROUP

Instance id: | SPB_DAQ_DATA/DM/IRU_MOTORS_SACT_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Scenes: | SPB_DAQ_DATA/DM/IRU_MOTORS_SACT_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### LCD-2_1030NM_GROUP

Instance id: | SPB_DAQ_DATA/DM/LCD-2_1030NM_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Scenes: | SPB_DAQ_DATA/DM/LCD-2_1030NM_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### LCD-2_800NM_GROUP

Instance id: | SPB_DAQ_DATA/DM/LCD-2_800NM_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Scenes: | SPB_DAQ_DATA/DM/LCD-2_800NM_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### RUN_CONTROL

Instance id: | SPB_DAQ_DATA/DM/RUN_CONTROL
Class id: | RunController
Host: | spb-br-sys-daq-srv1
Alias: | spb-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Projects: | SPB_RUN_MANAGEMENT, CAMERAs, MAIN_copy, SPB_TEST_DAQ_SLOW_DATA
Scenes: | SPB_RUN_CONTROL, Run Control (v2), AGIPD control - MFPGA, Grating_Stage_Control, SPB_RUN_CONTROL_2, SPB_RUN_CONTROL_2-OBSOLETE, SPB_DAQ, Run Control (v2), agipd_overview, SPB_DAQ, RunStatus, SPB_RUN_CONTROL, agipg64k_online_preview, OLD_DAQ_RUN_CONTROL, overview, agipd_overview, AGIPD control - Firmware tests, SPB_RUN_CONTROL-OBSOLETE, agipd_overview, SPB_DAQ_DATA/MDL/CONNECTION_CHECK|overview, agipd_overview, agipd_compact_monitoring_overview, IRU_D12_Overview_Old, Main, ShimadzuControl, SPB_RUN_CONTROL_GLOBAL_STATE, agipd_overview, Run_Controller_Basic, SPB_RUN_CONTROL_2_GLOBAL_STATE, AGIPD_Monitoring_Run_Control, IRU_D12_Overview_JB, IRU_D12_Overview_Old, IRU_D12_Overview_testMK0, IRU_D12_Overview, Instrument_State_Overview_large, Instrument_State_Overview, DAQ_Configuration_Helper, AGIPD_MONITORING_RUN_CONTROL_2_GLOBAL_STATE, Run_Repeater, Run_Controller, Instrument_State_Overview, Instrument_State_Overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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
- 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### RUN_CONTROL_2

Instance id: | SPB_DAQ_DATA/DM/RUN_CONTROL_2
Class id: | RunController
Host: | spb-br-sys-daq-srv1
Alias: | spb-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Scenes: | SPB_RUN_CONTROL_2, SPB_RUN_CONTROL_2-OBSOLETE, SPB_RUN_CONTROL_2_GLOBAL_STATE, AGIPD_Monitoring_Run_Control, AGIPD_MONITORING_RUN_CONTROL_2_GLOBAL_STATE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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
- 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### SA1_DOOCS_BAM_GROUP

Instance id: | SPB_DAQ_DATA/DM/SA1_DOOCS_BAM_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_AGIPD1M_POWER_HV_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_AGIPD1M_POWER_HV_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_AGIPD1M_TEMP_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_AGIPD1M_TEMP_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_AGIPD1M_TSYS_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_AGIPD1M_TSYS_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Scenes: | SPB_DAQ_DATA/DM/SPB_AGIPD1M_TSYS_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_DIGITIZERS_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_DIGITIZERS_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_EHC_PAM_CAM_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_EHC_PAM_CAM_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Scenes: | SPB_DAQ_DATA/DM/SPB_EHC_PAM_CAM_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_EHC_PAM_GOTTHARD_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_EHC_PAM_GOTTHARD_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Scenes: | SPB_DAQ_DATA/DM/SPB_EHC_PAM_GOTTHARD_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_EHC_PAM_MOTORS_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_EHC_PAM_MOTORS_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Scenes: | SPB_DAQ_DATA/DM/SPB_EHC_PAM_MOTORS_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_EHC_SCR_CAM_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_EHC_SCR_CAM_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_EHC_SON_MOTORS_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_EHC_SON_MOTORS_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_EHD_IBS_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_EHD_IBS_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_EHU_SCR_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_EHU_SCR_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Scenes: | SPB_DAQ_DATA/DM/SPB_EHU_SCR_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_EXP_ZYLA_CAM_1_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_EXP_ZYLA_CAM_1_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_EXP_ZYLA_CAM_2_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_EXP_ZYLA_CAM_2_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_EXP_ZYLA_CAM_3_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_EXP_ZYLA_CAM_3_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRDA_CAM_1_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRDA_CAM_1_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRDA_CAM_2_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRDA_CAM_2_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRU_DPA_SCR_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRU_DPA_SCR_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRU_INLINEMIC_CAM_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRU_INLINEMIC_CAM_GROUP
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-02-19T16:45:21.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Silenzi, Flucke, Costa
Latest tag: | 2.7.2
Deployment tag: | 2.7.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

[add instance documentation]

Release History
2.7.2

Created: | 2020-02-18T09:12:14.000Z
Author: | Gero Flucke
Notes: | Hotfix release to allow output channel schema updates

2.8.0a7

Created: | 2020-02-14T09:30:38.000Z
Author: | Alessandro Silenzi
Notes: | Test Tag

2.8.0a6

Created: | 2020-02-07T13:03:38.000Z
Author: | Alessandro Silenzi
Notes: |

deps-move-pugiXml

Created: | 2020-02-06T11:16:37.000Z
Author: | Alessandro Silenzi
Notes: | Configure PugiXML as a dependency

2.8.0a5

Created: | 2020-02-05T19:21:21.000Z
Author: | silenzi
Notes: |

2.8.0a4

Created: | 2020-01-31T10:43:35.000Z
Author: | Gero Flucke
Notes: | Weekly Test cycle tag a4

2.8.0a3

Created: | 2020-01-23T17:34:22.000Z
Author: | Raul Costa
Notes: |

2.7.1

Created: | 2020-01-22T12:09:51.000Z
Author: | Gero Flucke
Notes: | Hotfix release 2.7.1: - fix Tcp reading bug that made pipeline data with many small NDArray fail - fixes for file based logger against incomplete configurations from past - fix book-keeping of schema requests in gui server (bug can lead to unknown classes in gui client)

2.8.0a2

Created: | 2020-01-16T16:37:43.000Z
Author: | Dennis Goeries
Notes: | Experimental tag to allow weekly release tests

2.8.0a1

Created: | 2020-01-09T15:10:47.000Z
Author: | Dennis Goeries
Notes: |

2.7.0rc5

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | fifth release candidate for 2.7

2.7.0

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | Karabo 2.7.0 279 Merge Requests from 2.6.0

2.7.0a18

Created: | 2019-12-05T13:32:22.000Z
Author: | silenzi
Notes: |

2.7.0rc4

Created: | 2019-12-03T13:38:03.000Z
Author: | Gero Flucke
Notes: | 4-th release candidate. All C++ core changes are in. InfluxDB library connection and GUI improvements

2.7.0rc3

Created: | 2019-11-29T12:03:17.000Z
Author: | Denivy Rueck
Notes: | 3rd release candidate

2.6.5

Created: | 2019-11-26T15:59:14.000Z
Author: | Gero Flucke
Notes: | Hotfix to allow 100% safe instantiation of C++ DeviceClient

deps-remove-wxpython

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: |

2.7.0rc2

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: | New dependencies

2.7.0rc1

Created: | 2019-11-22T10:55:07.000Z
Author: | Gero Flucke
Notes: | First release candidate for 2.7.0 do not deploy in operation

deps-remove-guideps

Created: | 2019-11-15T13:41:59.000Z
Author: | Dennis Goeries
Notes: |

###### SPB_IRU_LIC_CAM_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRU_LIC_CAM_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRU_LIC_MOTORS_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRU_LIC_MOTORS_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRU_LIQUIDJET_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRU_LIQUIDJET_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRU_MCS_1_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRU_MCS_1_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRU_SIDEMIC_CAM2_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRU_SIDEMIC_CAM2_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRU_SIDEMIC_CAM_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRU_SIDEMIC_CAM_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_JNGFR_CTRL_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_JNGFR_CTRL_GROUP
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-02-19T16:45:21.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Silenzi, Flucke, Costa
Latest tag: | 2.7.2
Deployment tag: | 2.7.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

[add instance documentation]

Release History
2.7.2

Created: | 2020-02-18T09:12:14.000Z
Author: | Gero Flucke
Notes: | Hotfix release to allow output channel schema updates

2.8.0a7

Created: | 2020-02-14T09:30:38.000Z
Author: | Alessandro Silenzi
Notes: | Test Tag

2.8.0a6

Created: | 2020-02-07T13:03:38.000Z
Author: | Alessandro Silenzi
Notes: |

deps-move-pugiXml

Created: | 2020-02-06T11:16:37.000Z
Author: | Alessandro Silenzi
Notes: | Configure PugiXML as a dependency

2.8.0a5

Created: | 2020-02-05T19:21:21.000Z
Author: | silenzi
Notes: |

2.8.0a4

Created: | 2020-01-31T10:43:35.000Z
Author: | Gero Flucke
Notes: | Weekly Test cycle tag a4

2.8.0a3

Created: | 2020-01-23T17:34:22.000Z
Author: | Raul Costa
Notes: |

2.7.1

Created: | 2020-01-22T12:09:51.000Z
Author: | Gero Flucke
Notes: | Hotfix release 2.7.1: - fix Tcp reading bug that made pipeline data with many small NDArray fail - fixes for file based logger against incomplete configurations from past - fix book-keeping of schema requests in gui server (bug can lead to unknown classes in gui client)

2.8.0a2

Created: | 2020-01-16T16:37:43.000Z
Author: | Dennis Goeries
Notes: | Experimental tag to allow weekly release tests

2.8.0a1

Created: | 2020-01-09T15:10:47.000Z
Author: | Dennis Goeries
Notes: |

2.7.0rc5

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | fifth release candidate for 2.7

2.7.0

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | Karabo 2.7.0 279 Merge Requests from 2.6.0

2.7.0a18

Created: | 2019-12-05T13:32:22.000Z
Author: | silenzi
Notes: |

2.7.0rc4

Created: | 2019-12-03T13:38:03.000Z
Author: | Gero Flucke
Notes: | 4-th release candidate. All C++ core changes are in. InfluxDB library connection and GUI improvements

2.7.0rc3

Created: | 2019-11-29T12:03:17.000Z
Author: | Denivy Rueck
Notes: | 3rd release candidate

2.6.5

Created: | 2019-11-26T15:59:14.000Z
Author: | Gero Flucke
Notes: | Hotfix to allow 100% safe instantiation of C++ DeviceClient

deps-remove-wxpython

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: |

2.7.0rc2

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: | New dependencies

2.7.0rc1

Created: | 2019-11-22T10:55:07.000Z
Author: | Gero Flucke
Notes: | First release candidate for 2.7.0 do not deploy in operation

deps-remove-guideps

Created: | 2019-11-15T13:41:59.000Z
Author: | Dennis Goeries
Notes: |

###### SPB_JNGFR_M1_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_JNGFR_M1_GROUP
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-02-19T16:45:21.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Silenzi, Flucke, Costa
Latest tag: | 2.7.2
Deployment tag: | 2.7.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

[add instance documentation]

Release History
2.7.2

Created: | 2020-02-18T09:12:14.000Z
Author: | Gero Flucke
Notes: | Hotfix release to allow output channel schema updates

2.8.0a7

Created: | 2020-02-14T09:30:38.000Z
Author: | Alessandro Silenzi
Notes: | Test Tag

2.8.0a6

Created: | 2020-02-07T13:03:38.000Z
Author: | Alessandro Silenzi
Notes: |

deps-move-pugiXml

Created: | 2020-02-06T11:16:37.000Z
Author: | Alessandro Silenzi
Notes: | Configure PugiXML as a dependency

2.8.0a5

Created: | 2020-02-05T19:21:21.000Z
Author: | silenzi
Notes: |

2.8.0a4

Created: | 2020-01-31T10:43:35.000Z
Author: | Gero Flucke
Notes: | Weekly Test cycle tag a4

2.8.0a3

Created: | 2020-01-23T17:34:22.000Z
Author: | Raul Costa
Notes: |

2.7.1

Created: | 2020-01-22T12:09:51.000Z
Author: | Gero Flucke
Notes: | Hotfix release 2.7.1: - fix Tcp reading bug that made pipeline data with many small NDArray fail - fixes for file based logger against incomplete configurations from past - fix book-keeping of schema requests in gui server (bug can lead to unknown classes in gui client)

2.8.0a2

Created: | 2020-01-16T16:37:43.000Z
Author: | Dennis Goeries
Notes: | Experimental tag to allow weekly release tests

2.8.0a1

Created: | 2020-01-09T15:10:47.000Z
Author: | Dennis Goeries
Notes: |

2.7.0rc5

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | fifth release candidate for 2.7

2.7.0

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | Karabo 2.7.0 279 Merge Requests from 2.6.0

2.7.0a18

Created: | 2019-12-05T13:32:22.000Z
Author: | silenzi
Notes: |

2.7.0rc4

Created: | 2019-12-03T13:38:03.000Z
Author: | Gero Flucke
Notes: | 4-th release candidate. All C++ core changes are in. InfluxDB library connection and GUI improvements

2.7.0rc3

Created: | 2019-11-29T12:03:17.000Z
Author: | Denivy Rueck
Notes: | 3rd release candidate

2.6.5

Created: | 2019-11-26T15:59:14.000Z
Author: | Gero Flucke
Notes: | Hotfix to allow 100% safe instantiation of C++ DeviceClient

deps-remove-wxpython

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: |

2.7.0rc2

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: | New dependencies

2.7.0rc1

Created: | 2019-11-22T10:55:07.000Z
Author: | Gero Flucke
Notes: | First release candidate for 2.7.0 do not deploy in operation

deps-remove-guideps

Created: | 2019-11-15T13:41:59.000Z
Author: | Dennis Goeries
Notes: |

###### SPB_JNGFR_M2_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_JNGFR_M2_GROUP
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-02-19T16:45:21.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Silenzi, Flucke, Costa
Latest tag: | 2.7.2
Deployment tag: | 2.7.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

[add instance documentation]

Release History
2.7.2

Created: | 2020-02-18T09:12:14.000Z
Author: | Gero Flucke
Notes: | Hotfix release to allow output channel schema updates

2.8.0a7

Created: | 2020-02-14T09:30:38.000Z
Author: | Alessandro Silenzi
Notes: | Test Tag

2.8.0a6

Created: | 2020-02-07T13:03:38.000Z
Author: | Alessandro Silenzi
Notes: |

deps-move-pugiXml

Created: | 2020-02-06T11:16:37.000Z
Author: | Alessandro Silenzi
Notes: | Configure PugiXML as a dependency

2.8.0a5

Created: | 2020-02-05T19:21:21.000Z
Author: | silenzi
Notes: |

2.8.0a4

Created: | 2020-01-31T10:43:35.000Z
Author: | Gero Flucke
Notes: | Weekly Test cycle tag a4

2.8.0a3

Created: | 2020-01-23T17:34:22.000Z
Author: | Raul Costa
Notes: |

2.7.1

Created: | 2020-01-22T12:09:51.000Z
Author: | Gero Flucke
Notes: | Hotfix release 2.7.1: - fix Tcp reading bug that made pipeline data with many small NDArray fail - fixes for file based logger against incomplete configurations from past - fix book-keeping of schema requests in gui server (bug can lead to unknown classes in gui client)

2.8.0a2

Created: | 2020-01-16T16:37:43.000Z
Author: | Dennis Goeries
Notes: | Experimental tag to allow weekly release tests

2.8.0a1

Created: | 2020-01-09T15:10:47.000Z
Author: | Dennis Goeries
Notes: |

2.7.0rc5

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | fifth release candidate for 2.7

2.7.0

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | Karabo 2.7.0 279 Merge Requests from 2.6.0

2.7.0a18

Created: | 2019-12-05T13:32:22.000Z
Author: | silenzi
Notes: |

2.7.0rc4

Created: | 2019-12-03T13:38:03.000Z
Author: | Gero Flucke
Notes: | 4-th release candidate. All C++ core changes are in. InfluxDB library connection and GUI improvements

2.7.0rc3

Created: | 2019-11-29T12:03:17.000Z
Author: | Denivy Rueck
Notes: | 3rd release candidate

2.6.5

Created: | 2019-11-26T15:59:14.000Z
Author: | Gero Flucke
Notes: | Hotfix to allow 100% safe instantiation of C++ DeviceClient

deps-remove-wxpython

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: |

2.7.0rc2

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: | New dependencies

2.7.0rc1

Created: | 2019-11-22T10:55:07.000Z
Author: | Gero Flucke
Notes: | First release candidate for 2.7.0 do not deploy in operation

deps-remove-guideps

Created: | 2019-11-15T13:41:59.000Z
Author: | Dennis Goeries
Notes: |

###### SPB_JNGFR_M3_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_JNGFR_M3_GROUP
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-02-19T16:45:21.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Silenzi, Flucke, Costa
Latest tag: | 2.7.2
Deployment tag: | 2.7.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

[add instance documentation]

Release History
2.7.2

Created: | 2020-02-18T09:12:14.000Z
Author: | Gero Flucke
Notes: | Hotfix release to allow output channel schema updates

2.8.0a7

Created: | 2020-02-14T09:30:38.000Z
Author: | Alessandro Silenzi
Notes: | Test Tag

2.8.0a6

Created: | 2020-02-07T13:03:38.000Z
Author: | Alessandro Silenzi
Notes: |

deps-move-pugiXml

Created: | 2020-02-06T11:16:37.000Z
Author: | Alessandro Silenzi
Notes: | Configure PugiXML as a dependency

2.8.0a5

Created: | 2020-02-05T19:21:21.000Z
Author: | silenzi
Notes: |

2.8.0a4

Created: | 2020-01-31T10:43:35.000Z
Author: | Gero Flucke
Notes: | Weekly Test cycle tag a4

2.8.0a3

Created: | 2020-01-23T17:34:22.000Z
Author: | Raul Costa
Notes: |

2.7.1

Created: | 2020-01-22T12:09:51.000Z
Author: | Gero Flucke
Notes: | Hotfix release 2.7.1: - fix Tcp reading bug that made pipeline data with many small NDArray fail - fixes for file based logger against incomplete configurations from past - fix book-keeping of schema requests in gui server (bug can lead to unknown classes in gui client)

2.8.0a2

Created: | 2020-01-16T16:37:43.000Z
Author: | Dennis Goeries
Notes: | Experimental tag to allow weekly release tests

2.8.0a1

Created: | 2020-01-09T15:10:47.000Z
Author: | Dennis Goeries
Notes: |

2.7.0rc5

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | fifth release candidate for 2.7

2.7.0

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | Karabo 2.7.0 279 Merge Requests from 2.6.0

2.7.0a18

Created: | 2019-12-05T13:32:22.000Z
Author: | silenzi
Notes: |

2.7.0rc4

Created: | 2019-12-03T13:38:03.000Z
Author: | Gero Flucke
Notes: | 4-th release candidate. All C++ core changes are in. InfluxDB library connection and GUI improvements

2.7.0rc3

Created: | 2019-11-29T12:03:17.000Z
Author: | Denivy Rueck
Notes: | 3rd release candidate

2.6.5

Created: | 2019-11-26T15:59:14.000Z
Author: | Gero Flucke
Notes: | Hotfix to allow 100% safe instantiation of C++ DeviceClient

deps-remove-wxpython

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: |

2.7.0rc2

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: | New dependencies

2.7.0rc1

Created: | 2019-11-22T10:55:07.000Z
Author: | Gero Flucke
Notes: | First release candidate for 2.7.0 do not deploy in operation

deps-remove-guideps

Created: | 2019-11-15T13:41:59.000Z
Author: | Dennis Goeries
Notes: |

###### SPB_JNGFR_M6_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_JNGFR_M6_GROUP
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-02-19T16:45:21.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Silenzi, Flucke, Costa
Latest tag: | 2.7.2
Deployment tag: | 2.7.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

[add instance documentation]

Release History
2.7.2

Created: | 2020-02-18T09:12:14.000Z
Author: | Gero Flucke
Notes: | Hotfix release to allow output channel schema updates

2.8.0a7

Created: | 2020-02-14T09:30:38.000Z
Author: | Alessandro Silenzi
Notes: | Test Tag

2.8.0a6

Created: | 2020-02-07T13:03:38.000Z
Author: | Alessandro Silenzi
Notes: |

deps-move-pugiXml

Created: | 2020-02-06T11:16:37.000Z
Author: | Alessandro Silenzi
Notes: | Configure PugiXML as a dependency

2.8.0a5

Created: | 2020-02-05T19:21:21.000Z
Author: | silenzi
Notes: |

2.8.0a4

Created: | 2020-01-31T10:43:35.000Z
Author: | Gero Flucke
Notes: | Weekly Test cycle tag a4

2.8.0a3

Created: | 2020-01-23T17:34:22.000Z
Author: | Raul Costa
Notes: |

2.7.1

Created: | 2020-01-22T12:09:51.000Z
Author: | Gero Flucke
Notes: | Hotfix release 2.7.1: - fix Tcp reading bug that made pipeline data with many small NDArray fail - fixes for file based logger against incomplete configurations from past - fix book-keeping of schema requests in gui server (bug can lead to unknown classes in gui client)

2.8.0a2

Created: | 2020-01-16T16:37:43.000Z
Author: | Dennis Goeries
Notes: | Experimental tag to allow weekly release tests

2.8.0a1

Created: | 2020-01-09T15:10:47.000Z
Author: | Dennis Goeries
Notes: |

2.7.0rc5

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | fifth release candidate for 2.7

2.7.0

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | Karabo 2.7.0 279 Merge Requests from 2.6.0

2.7.0a18

Created: | 2019-12-05T13:32:22.000Z
Author: | silenzi
Notes: |

2.7.0rc4

Created: | 2019-12-03T13:38:03.000Z
Author: | Gero Flucke
Notes: | 4-th release candidate. All C++ core changes are in. InfluxDB library connection and GUI improvements

2.7.0rc3

Created: | 2019-11-29T12:03:17.000Z
Author: | Denivy Rueck
Notes: | 3rd release candidate

2.6.5

Created: | 2019-11-26T15:59:14.000Z
Author: | Gero Flucke
Notes: | Hotfix to allow 100% safe instantiation of C++ DeviceClient

deps-remove-wxpython

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: |

2.7.0rc2

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: | New dependencies

2.7.0rc1

Created: | 2019-11-22T10:55:07.000Z
Author: | Gero Flucke
Notes: | First release candidate for 2.7.0 do not deploy in operation

deps-remove-guideps

Created: | 2019-11-15T13:41:59.000Z
Author: | Dennis Goeries
Notes: |

###### SPB_JNGFR_M7_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_JNGFR_M7_GROUP
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-02-19T16:45:21.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Silenzi, Flucke, Costa
Latest tag: | 2.7.2
Deployment tag: | 2.7.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

[add instance documentation]

Release History
2.7.2

Created: | 2020-02-18T09:12:14.000Z
Author: | Gero Flucke
Notes: | Hotfix release to allow output channel schema updates

2.8.0a7

Created: | 2020-02-14T09:30:38.000Z
Author: | Alessandro Silenzi
Notes: | Test Tag

2.8.0a6

Created: | 2020-02-07T13:03:38.000Z
Author: | Alessandro Silenzi
Notes: |

deps-move-pugiXml

Created: | 2020-02-06T11:16:37.000Z
Author: | Alessandro Silenzi
Notes: | Configure PugiXML as a dependency

2.8.0a5

Created: | 2020-02-05T19:21:21.000Z
Author: | silenzi
Notes: |

2.8.0a4

Created: | 2020-01-31T10:43:35.000Z
Author: | Gero Flucke
Notes: | Weekly Test cycle tag a4

2.8.0a3

Created: | 2020-01-23T17:34:22.000Z
Author: | Raul Costa
Notes: |

2.7.1

Created: | 2020-01-22T12:09:51.000Z
Author: | Gero Flucke
Notes: | Hotfix release 2.7.1: - fix Tcp reading bug that made pipeline data with many small NDArray fail - fixes for file based logger against incomplete configurations from past - fix book-keeping of schema requests in gui server (bug can lead to unknown classes in gui client)

2.8.0a2

Created: | 2020-01-16T16:37:43.000Z
Author: | Dennis Goeries
Notes: | Experimental tag to allow weekly release tests

2.8.0a1

Created: | 2020-01-09T15:10:47.000Z
Author: | Dennis Goeries
Notes: |

2.7.0rc5

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | fifth release candidate for 2.7

2.7.0

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | Karabo 2.7.0 279 Merge Requests from 2.6.0

2.7.0a18

Created: | 2019-12-05T13:32:22.000Z
Author: | silenzi
Notes: |

2.7.0rc4

Created: | 2019-12-03T13:38:03.000Z
Author: | Gero Flucke
Notes: | 4-th release candidate. All C++ core changes are in. InfluxDB library connection and GUI improvements

2.7.0rc3

Created: | 2019-11-29T12:03:17.000Z
Author: | Denivy Rueck
Notes: | 3rd release candidate

2.6.5

Created: | 2019-11-26T15:59:14.000Z
Author: | Gero Flucke
Notes: | Hotfix to allow 100% safe instantiation of C++ DeviceClient

deps-remove-wxpython

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: |

2.7.0rc2

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: | New dependencies

2.7.0rc1

Created: | 2019-11-22T10:55:07.000Z
Author: | Gero Flucke
Notes: | First release candidate for 2.7.0 do not deploy in operation

deps-remove-guideps

Created: | 2019-11-15T13:41:59.000Z
Author: | Dennis Goeries
Notes: |

###### SPB_JNGFR_M8_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_JNGFR_M8_GROUP
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-02-19T16:45:21.000+01:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Silenzi, Flucke, Costa
Latest tag: | 2.7.2
Deployment tag: | 2.7.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

[add instance documentation]

Release History
2.7.2

Created: | 2020-02-18T09:12:14.000Z
Author: | Gero Flucke
Notes: | Hotfix release to allow output channel schema updates

2.8.0a7

Created: | 2020-02-14T09:30:38.000Z
Author: | Alessandro Silenzi
Notes: | Test Tag

2.8.0a6

Created: | 2020-02-07T13:03:38.000Z
Author: | Alessandro Silenzi
Notes: |

deps-move-pugiXml

Created: | 2020-02-06T11:16:37.000Z
Author: | Alessandro Silenzi
Notes: | Configure PugiXML as a dependency

2.8.0a5

Created: | 2020-02-05T19:21:21.000Z
Author: | silenzi
Notes: |

2.8.0a4

Created: | 2020-01-31T10:43:35.000Z
Author: | Gero Flucke
Notes: | Weekly Test cycle tag a4

2.8.0a3

Created: | 2020-01-23T17:34:22.000Z
Author: | Raul Costa
Notes: |

2.7.1

Created: | 2020-01-22T12:09:51.000Z
Author: | Gero Flucke
Notes: | Hotfix release 2.7.1: - fix Tcp reading bug that made pipeline data with many small NDArray fail - fixes for file based logger against incomplete configurations from past - fix book-keeping of schema requests in gui server (bug can lead to unknown classes in gui client)

2.8.0a2

Created: | 2020-01-16T16:37:43.000Z
Author: | Dennis Goeries
Notes: | Experimental tag to allow weekly release tests

2.8.0a1

Created: | 2020-01-09T15:10:47.000Z
Author: | Dennis Goeries
Notes: |

2.7.0rc5

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | fifth release candidate for 2.7

2.7.0

Created: | 2019-12-11T15:42:38.000Z
Author: | Alessandro Silenzi
Notes: | Karabo 2.7.0 279 Merge Requests from 2.6.0

2.7.0a18

Created: | 2019-12-05T13:32:22.000Z
Author: | silenzi
Notes: |

2.7.0rc4

Created: | 2019-12-03T13:38:03.000Z
Author: | Gero Flucke
Notes: | 4-th release candidate. All C++ core changes are in. InfluxDB library connection and GUI improvements

2.7.0rc3

Created: | 2019-11-29T12:03:17.000Z
Author: | Denivy Rueck
Notes: | 3rd release candidate

2.6.5

Created: | 2019-11-26T15:59:14.000Z
Author: | Gero Flucke
Notes: | Hotfix to allow 100% safe instantiation of C++ DeviceClient

deps-remove-wxpython

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: |

2.7.0rc2

Created: | 2019-11-23T17:09:02.000Z
Author: | Alessandro Silenzi
Notes: | New dependencies

2.7.0rc1

Created: | 2019-11-22T10:55:07.000Z
Author: | Gero Flucke
Notes: | First release candidate for 2.7.0 do not deploy in operation

deps-remove-guideps

Created: | 2019-11-15T13:41:59.000Z
Author: | Dennis Goeries
Notes: |

###### SPB_JNGFR_MOTORS_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_JNGFR_MOTORS_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_MKB_MOTORS_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_MKB_MOTORS_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_MKB_SCR1_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_MKB_SCR1_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Scenes: | SPB_DAQ_DATA/DM/SPB_MKB_SCR1_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_MKB_SCR2_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_MKB_SCR2_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Scenes: | SPB_DAQ_DATA/DM/SPB_MKB_SCR2_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_NKB_SCR_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_NKB_SCR_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Scenes: | SPB_DAQ_DATA/DM/SPB_NKB_SCR_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_OHD_SCR_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_OHD_SCR_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Scenes: | SPB_DAQ_DATA/DM/SPB_OHD_SCR_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_PPL_LAS_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_PPL_LAS_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Scenes: | SPB_DAQ_DATA/DM/SPB_PPL_LAS_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_XTD9_PPSCAN_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_XTD9_PPSCAN_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Scenes: | SPB_DAQ_DATA/DM/SPB_XTD9_PPSCAN_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_XTD9_SCR_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_XTD9_SCR_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Scenes: | SPB_DAQ_DATA/DM/SPB_XTD9_SCR_GROUP|scene
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### AGIPD64K_XTDF_AUX_GROUP

Instance id: | SPB_DAQ_DATA/DM/AGIPD64K_XTDF_AUX_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_TIMING_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_TIMING_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_AGIPD1M_CTRL_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_AGIPD1M_CTRL_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRDA_JF4M_1_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRDA_JF4M_1_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRDA_JF4M_2_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRDA_JF4M_2_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRDA_JF4M_3_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRDA_JF4M_3_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRDA_JF4M_6_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRDA_JF4M_6_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRDA_JF4M_7_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRDA_JF4M_7_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRDA_JF4M_8_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRDA_JF4M_8_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRDA_JF4M_CTRL_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRDA_JF4M_CTRL_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRD_SACT_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRD_SACT_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRDA_JF4M_4_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRDA_JF4M_4_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRDA_JF4M_5_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRDA_JF4M_5_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SBP_EHD_HPVX2_1_GROUP

Instance id: | SPB_DAQ_DATA/DM/SBP_EHD_HPVX2_1_GROUP
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-06-29T13:11:17.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Carinan, Giovanetti, Flucke
Latest tag: | 2.10.0a6
Deployment tag: | 2.10.0a6
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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
- x0:
    X coordinate of the maximum intensity pixel.
- y0:
    Y coordinate of the maximum intensity pixel.
- fwhmX:
    Full Width at Half Maximum for X projection, A.K.A. beam width.
- fwhmY:
    Full Width at Half Maximum for Y projection, A.K.A. beam height.
- frameRate:
    Rate of processed images.
- resetError:
    Reset error count.
- _connection_:
    The connection to the communication layer of the distributed system
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- reset:
    Reset
- 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.
- sx:
    Standard deviation in X 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.
- version:
    Software version
- 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
- 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:
    Defines whether interlock conditions are configurable from this interface.
- devicesBlacklist:
    List of the devices that will not be instantiated automatically.
- instantiationInterval:
    The interval between consecutive instantiations
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    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
- 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.
- updateInterval:
    The interval for updating DOOCS for read-out values.
- doocsProperties:
    DOOCS Properties to monitor and set (if writeable)
- doocsLocation:
    DOOCS Location to monitor
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- stop:
    Instructs camera to stop current acquisition
- interfaces:
    Describes the interfaces of this device
- outputFrameRate:
    Output frame rate of Karabo device.
- cameraIp:
    The IP address of the camera.
- isStrict:
    If true, device goes in error if value is refused from the Hardware
- rebootRcs:
    Reboots the RCS camera controller. Useful after the camera has been power cycled (RCS must always boot AFTER the Zyla camera is powered up)
- acquireMode:
    Select whether acquisition will run in LIVE (free roll streaming) or RECORDING (burst) mode
- isCamConnected:
    Camera HW is connected to RCS industrial PC
- opMode:
    DISCONNECTED: 0 | IDLE: 1 | LIVE: 2 | RECORDING: 3 | PLAYBACK: 4
- triggerMode:
    Select the trigger mode, referred as ‘record mode’ on HW manuals
- recordMode:
    ‘Record Mode’ (aka trigger mode) encoding on device.
- nOfFrames:
    14. of frames to be recorded in a burst (in acquisition mode RECORDING)
- recordFrames:
    0: FRAME_128 | 1: FRAME_256
- streamRate:
    Desired frame rate, used both in LIVE and in RECORDING (burst) mode
- triggerPoint:
    Setting the trigger point to N, ensures thatN pre-trigger frames are acquired. Values from 2to 128/256 (the number of frames in burst) can be chosen
- triggerPointRange:
    Allowed range for trigger point.
- triggerDelay:
    Trigger Delay
- triggerDelayRange:
    Allowed Range for trigger delay.
- triggerPolarity:
    Trigger Polarity
- standbyDelay:
    Standby Delay
- standbyDelayRange:
    Allowed Range for standby delay.
- standbyPolarity:
    Standby Polarity
- liveExposureTime:
    Exposure time for LIVE images
- liveExposureTimeRange:
    Allowed Range for live exposure time.
- recordingSpeed:
    Speed of RECORDING mode (1 /burst frames rate )
- recordingSpeedTimeRange:
    Allowed Range for recording speed.
- recordingExposureTime:
    Exposure time for burst frames
- recordingExposureTimeRange:
    Allowed Range for burst frames exposure time.
- client_email:
    Metadata Catalogue Client User email address
- client_id:
    Metadata Catalogue User Oauth identifier
- client_secret:
    Metadata Catalogue User Oauth secret
- metadata_application_url:
    Metadata Catalogue application Web Url
- ignore:
    Ignore
- configure:
    configure
- monitor:
    Monitor
- record:
    Record
- tune:
    Tune
- toggle:
    Pause/resume
- 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:
    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.
- configurations:
    All configuration groups and their sources
- sources:
    Overall list of data sources and their attributes
- operationMode:
    Operation mode
- metadataSchemaVersion:
    Metadata schema version
- proposalNumber:
    Proposal number
- experiment:
    Experiment
- sample:
    Sample
- runNumber:
    Run number
- user:
    User
- localConfiguration:
    Local configuration
- remoteConfiguration:
    Remote configuration
- debug:
    Debug mode
- slotPushToDaq:
    Push run configuration to DAQ
- slotRetrieveProposalDetails:
    Retrieve proposal details
- actions:
    Actions
- defaultMaxSize:
    Default max size for vectors when this is not specified in data schema
- runConfigurator:
    Run configurator
- 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:
    Data aggregators
- clientId:
    Client Id
- daqManager:
    DAQ management system
- on:
    Instructs the device to switch on
- off:
    Instructs device to switch off
- pwmFrequency:
- pwmDutyCycle:
- pwmCycleLimit:
    Number Of PWM Cycles, 0 = inifite number of cycles
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group
- 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.10.0a6

Created: | 2020-06-26T13:00:28.000Z
Author: | Cammille Carinan
Notes: |

2.9.2

Created: | 2020-06-25T17:07:24.000Z
Author: | Gero Flucke
Notes: | Various fixes and improvement in data logging, especially to make influx logging production ready.

2.9.2rc1

Created: | 2020-06-23T12:50:40.000Z
Author: | Alessandro Silenzi
Notes: | Influx Hotfix Branch

2.10.0a5

Created: | 2020-06-18T14:21:41.000Z
Author: | Gero Flucke
Notes: | weekly test

2.10.0a4

Created: | 2020-06-12T16:44:23.000Z
Author: | Raul Costa
Notes: | Weekly release

2.10.0a3

Created: | 2020-06-05T13:11:59.000Z
Author: | Gero Flucke
Notes: | weekly alpha release

2.9.1

Created: | 2020-06-05T11:53:01.000Z
Author: | Gero Flucke
Notes: | fixes to influx migration scripts silence gui server log file better influxDB logger failure report when initialising fix karabo script device install bug (deployment) Bound: Backport fix of signalAlarmUpdate

deps-upgrade-openmqc514

Created: | 2020-05-28T04:50:55.000Z
Author: | Alessandro Silenzi
Notes: |

2.10.0a2

Created: | 2020-05-28T04:50:55.000Z
Author: | Alessandro Silenzi
Notes: | weekly test release

2.10.0a1

Created: | 2020-05-16T06:56:54.000Z
Author: | Alessandro Silenzi
Notes: | Alpha release. Equivalent to 2.9.0 except for migration tool improvements.

2.9.0rc3

Created: | 2020-05-14T17:24:26.000Z
Author: | Dennis Goeries
Notes: |

2.9.0

Created: | 2020-05-14T17:24:26.000Z
Author: | Dennis Goeries
Notes: | Release of 2.9.0

2.9.0rc2

Created: | 2020-05-13T11:43:24.000Z
Author: | Dennis Goeries
Notes: | second release candidate of 2.9.0

2.9.0rc1

Created: | 2020-05-11T18:03:01.000Z
Author: | Dennis Goeries
Notes: | First release candidate of 2.9.0

2.9.0a6

Created: | 2020-04-29T17:32:07.000Z
Author: | Cammille Carinan
Notes: | weekly release candidate

2.9.0a5

Created: | 2020-04-27T14:44:56.000Z
Author: | Cammille Carinan
Notes: | weekly release candidate

2.8.3

Created: | 2020-04-23T15:10:47.000Z
Author: | Steffen Hauf
Notes: | FEAT: Project DB list devices

2.9.0a4

Created: | 2020-04-17T12:49:03.000Z
Author: | Gero Flucke
Notes: | Weekly release test

2.7.4

Created: | 2020-04-07T16:30:21.000Z
Author: | Alessandro Silenzi
Notes: | Back port CI changes

2.8.2

Created: | 2020-04-07T13:17:45.000Z
Author: | Dennis Goeries
Notes: | Cherry picked !4311 MDL: Increase number of threads in executor

###### SPB_EHD_HPVX2_1_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_EHD_HPVX2_1_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_TSYS_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_TSYS_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_DELAYGEN_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_DELAYGEN_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRU_MCS2-3AXIS-1_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRU_MCS2-3AXIS-1_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_WFS_MOTORS_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_WFS_MOTORS_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_EHC_PAM_SPECTRUMTREND_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_EHC_PAM_SPECTRUMTREND_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### DATA_MANAGER_2

Instance id: | SPB_DAQ_DATA/DM/DATA_MANAGER_2
Class id: | DataManager
Host: | spb-br-sys-daq-srv1
Alias: | spb-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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
- 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### SA1_HIREX_GROUP

Instance id: | SPB_DAQ_DATA/DM/SA1_HIREX_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SA1_MIRRORS_GROUP

Instance id: | SPB_DAQ_DATA/DM/SA1_MIRRORS_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SA1_XTD9_SHIMADZU_CAM_GROUP

Instance id: | SPB_DAQ_DATA/DM/SA1_XTD9_SHIMADZU_CAM_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_DOC_ADHOC_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_DOC_ADHOC_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_FADC_1_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_FADC_1_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_FADC_2_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_FADC_2_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_IRU_INLINEMIC_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_IRU_INLINEMIC_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Projects: | SPB_RUN_MANAGEMENT, CAMERAs, MAIN_copy
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

###### SPB_LAS_NS_DG_GROUP

Instance id: | SPB_DAQ_DATA/DM/SPB_LAS_NS_DG_GROUP
Class id: | RunConfigurationGroup
Host: | spb-br-sys-daq-dsg1
Alias: | spb-br-sys-daq-dsg1
Git repo: | https://git.xfel.eu/gitlab/Karabo/Framework
Last modified: | 2021-07-02T14:33:16.000+02:00
Created at: | 2016-02-25T15:17:38.000+01:00
Main authors: | Flucke, Goeries
Latest tag: | 2.11.2
Deployment tag: | 2.11.2
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- group:
    Structure describing data sources logically belonging together.
- owner:
    The person to contact regarding usage of this group

Release History
2.11.2

Created: | 2021-06-29T12:30:20.000Z
Author: | Gero Flucke
Notes: |

2.11.2rc4

Created: | 2021-06-23T15:14:20.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc3

Created: | 2021-06-22T17:53:47.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc2

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.2rc1

Created: | 2021-06-22T14:50:11.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a2

Created: | 2021-06-17T16:59:47.000Z
Author: | Dennis Goeries
Notes: |

2.12.0a1

Created: | 2021-06-11T14:35:54.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b15

Created: | 2021-06-07T13:19:02.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b14

Created: | 2021-06-04T17:50:53.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b13

Created: | 2021-06-04T17:24:11.000Z
Author: | Dennis Goeries
Notes: |

2.11.1b3

Created: | 2021-06-04T11:16:10.000Z
Author: | Dennis Goeries
Notes: |

2.11.1rc3

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | 3rd RC

2.11.1

Created: | 2021-06-02T08:40:48.000Z
Author: | Dennis Goeries
Notes: | First Patch release of Karabo 2.11 Reverted the changes in middlelayer device initialization. And a few GUI fixes.

2.11.1rc2

Created: | 2021-06-02T08:38:31.000Z
Author: | Gero Flucke
Notes: |

2.11.1rc1

Created: | 2021-05-31T10:16:58.000Z
Author: | Alessandro Silenzi
Notes: | 1st RC of 2.11.1

2.10.5

Created: | 2021-05-27T08:46:50.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc9

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | 9-th release candidate

2.11.0

Created: | 2021-05-17T15:42:57.000Z
Author: | Dennis Goeries
Notes: | Karabo version 2.11.0 The most relevant improvements, fixes and changes are: MDL and BOUND Python upgraded to 3.8 Performance enhancements on broker communication experimental support of MQTT as a broker GUI Qt Upgraded to 5.12 Consolidation of Table elements in GUI and GUI performance enhancements See: https://in.xfel.eu/readthedocs/docs/karabo/en/latest/whatsnew/2.11.html for more details.

deps-add-aioredis

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: |

2.11.0rc8

Created: | 2021-05-14T16:04:14.000Z
Author: | Alessandro Silenzi
Notes: | 8-th release candidate

##### AGIPD1MCTRL

[add component documentation]

###### 0

Instance id: | SPB_DAQ_DATA/AGIPD1MCTRL/0
Class id: | DataAggregator
Host: | spb-br-sys-daq-da2
Alias: | spb-br-sys-daq-da2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Scenes: | CORRECTED_OVERVIEW, SPB_RUN_CONTROL-OBSOLETE, agipd_overview, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, agipd_overview_zoom
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

##### JNGFRCTRL

[add component documentation]

###### 0

Instance id: | SPB_DAQ_DATA/JNGFRCTRL/0
Class id: | DataAggregator
Host: | spb-br-sys-daq-da3
Alias: | spb-br-sys-daq-da3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Scenes: | SPB_RUN_CONTROL-OBSOLETE
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

##### MDL

[add component documentation]

###### CONNECTION_CHECK

##### HPVX

[add component documentation]

###### 1

Instance id: | SPB_DAQ_DATA/HPVX/1
Class id: | DataAggregator
Host: | spb-br-sys-daq-da1
Alias: | spb-br-sys-daq-da1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Scenes: | SPB_DAQ_STATUS-OBSOLETE, SPB_RUN_CONTROL-OBSOLETE, Main, ShimadzuControl
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

##### DOC

[add component documentation]

###### 1

Instance id: | SPB_DAQ_DATA/DOC/1
Class id: | DataAggregator
Host: | spb-br-sys-daq-da4
Alias: | spb-br-sys-daq-da4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

#### AGIP1M-1

[add component documentation]

##### DM

[add component documentation]

###### MDC_REMOTE

Instance id: | SPB_DAQ_AGIP1M-1/DM/MDC_REMOTE
Class id: | MetadataDBRemote
Host: | spb-br-sys-daq-srv1
Alias: | spb-br-sys-daq-srv1
Git repo: | https://git.xfel.eu/gitlab/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: | AGIPD_RUN_MANAGEMENT, SPB_RUN_MANAGEMENT, CAMERAs, MAIN_copy, SPB_TEST_DAQ_SLOW_DATA
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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-23T12:55:12.000Z
Author: | Luis Maia
Notes: | Release tag 3.3.0-2.11.1

3.2.2-2.11.1

Created: | 2021-06-18T12:42:04.000Z
Author: | Luis Maia
Notes: | Release tag 3.2.2-2.11.1

3.2.2-2.10.5

Created: | 2021-06-04T13:22:01.000Z
Author: | Luis Maia
Notes: | Release tag 3.2.2-2.10.5

3.2.1-2.10.5.rc1

Created: | 2021-06-03T15:17:57.000Z
Author: | Luis Maia
Notes: | Release tag 3.2.1-2.10.5.rc1

3.2.0-2.10.5

Created: | 2021-06-03T01:39:27.000Z
Author: | Luis Maia
Notes: | Release tag 3.2.0-2.10.5

3.1.0-2.10.5

Created: | 2021-06-02T20:52:53.000Z
Author: | Luis Maia
Notes: | Release tag 3.1.0-2.10.5

3.0.7-2.10.1-rx1

Created: | 2021-06-02T10:57:58.000Z
Author: | Nasser Al-Qudami
Notes: |

3.0.7-2.9.2

Created: | 2020-06-30T20:51:41.000Z
Author: | Luis Maia
Notes: | Release tag 3.0.7-2.9.2

3.0.6-2.9.1_rc1

Created: | 2020-06-11T08:48:57.000Z
Author: | Luis Maia
Notes: | Release tag 3.0.6-2.9.1_rc1

3.0.4-2.9.1

Created: | 2020-01-27T11:14:04.000Z
Author: | Luis Maia
Notes: | Release tag 3.0.4-2.9.1

3.0.4-2.7.0

Created: | 2020-01-27T11:14:04.000Z
Author: | Luis Maia
Notes: | Release tag 3.0.4-2.7.0

3.0.3-2.6.1

Created: | 2019-08-23T06:12:16.000Z
Author: | Luis Maia
Notes: | Release tag 3.0.3-2.6.1

3.0.3-2.5.1

Created: | 2019-08-22T22:53:46.000Z
Author: | Luis Maia
Notes: | Release tag 3.0.3-2.5.1

3.0.0-2.5.1

Created: | 2019-08-16T13:26:20.000Z
Author: | Luis Maia
Notes: | Release tag 3.0.0-2.5.1

2.0.0-2.2.0

Created: | 2017-12-21T14:52:41.000Z
Author: | Luis Maia
Notes: | Release tag 2.0.0-2.2.0

1.1.6-2.1.18

Created: | 2017-12-21T08:32:55.000Z
Author: | Luis Maia
Notes: | Release tag 1.1.6-2.1.18

1.1.5-2.1.18

Created: | 2017-12-20T10:48:53.000Z
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-10T13:19:21.000Z
Author: | Luis Maia
Notes: | Release tag 1.1.4-2.1.16

1.1.2-2.1.12

Created: | 2017-09-13T18:17:46.000Z
Author: | Luis Maia
Notes: | Release tag 1.1.2-2.1.12

1.1.1-2.1.12

Created: | 2017-09-04T16:42:01.000Z
Author: | Luis Maia
Notes: | Release tag 1.1.1-2.1.12

#### SCAN

[add component documentation]

##### MDL

[add component documentation]

###### DAQ_CONTROLLER

Instance id: | SPB_DAQ_SCAN/MDL/DAQ_CONTROLLER
Class id: | DaqController
Host: | spb-rr-sys-con-spc
Alias: | spb-rr-sys-con-spc
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/daqController
Last modified: | 2021-06-09T16:39:42.000+02:00
Created at: | 2019-03-11T15:44:30.000+01:00
Main authors: | Haufs, Parenti, Cas
Latest tag: | 1.4.4-2.10.0-hotfix@SPB
Deployment tag: | 1.4.4-2.10.0-hotfix@SPB
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- daqTimeout:
    The configuration timeout to wait for DAQ state changes
- runController:
    The deviceId of the RunController to use, starts and stops daq.
- autoFill:
    Automatically fill the list of DataAggregators from the RunController. Uncheck to manually define the relevant DataAggregators.
- dataAggregators:
    The deviceId to the DataAggregators on the current RunController. Tick autoFill to fill automatically.
- runConfigurator:
    The deviceId of the current RunConfigurator. It is filled automatically.
- start:
    Start DAQ with the previously applied configuration
- stop:
    Stop the current run.
- setup:
    Configure the DAQ before acquisition and check device states.
- toggle:
    Pause or resume a running acquisition.

Release History
1.4.4-2.10.0-hotfix@SPB

Created: | 2021-02-24T16:55:09.000Z
Author: | Gabriele Giovanetti
Notes: | For use with JungfrauDarkChar device

1.4.4-2.10.0

Created: | 2020-11-24T21:11:03.000Z
Author: | Wajid Ehsan
Notes: | Version Update Info

1.4.3-2.9.0

Created: | 2020-08-21T08:53:55.000Z
Author: | Andrea Parenti
Notes: | Summary: Internal refactor needed by AgipdDaqController derived class

1.4.2-2.9.0

Created: | 2020-08-20T12:48:22.000Z
Author: | Andrea Parenti
Notes: | Summary: Split-off autoFill from onInitialization

1.4.1-2.9.0

Created: | 2020-07-15T11:27:28.000Z
Author: | Istvan Mohacsi
Notes: |

1.4.0-2.9.0

Created: | 2020-06-04T14:30:28.000Z
Author: | Istvan Mohacsi
Notes: | Added device scene.

1.3.1-2.8.0

Created: | 2020-05-14T10:43:24.000Z
Author: | Istvan Mohacsi
Notes: |

1.30-2.8.0-test

Created: | 2020-04-28T09:20:59.000Z
Author: | Istvan Mohacsi
Notes: | The pause / resume feature was only tested on unofficial installation.

1.2.0-2.8.0

Created: | 2020-03-03T12:03:14.000Z
Author: | Istvan Mohacsi
Notes: |

1.1.2-2.7.0

Created: | 2020-02-20T11:52:23.000Z
Author: | Denys Mamchyk
Notes: | starts after waiting for a proper data aggregators state

1.1.1-2.6.0

Created: | 2019-09-27T11:19:01.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.5.0

Created: | 2019-08-29T15:29:20.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.5.0

Created: | 2019-07-09T09:22:23.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.4.0

Created: | 2019-05-16T16:38:41.000Z
Author: | Istvan Mohacsi
Notes: |

1.0.0-2.4.0

Created: | 2019-04-15T15:45:23.000Z
Author: | Dennis Goeries
Notes: |

###### KARABACON

Instance id: | SPB_DAQ_SCAN/MDL/KARABACON
Class id: | Karabacon
Host: | spb-rr-sys-con-spc
Class documentation:
| Karabacon
Alias: | spb-rr-sys-con-spc
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Karabacon
Last modified: | 2021-07-01T20:52:37.000+02:00
Created at: | 2017-08-04T19:53:23.000+02:00
Main authors: | Hauf, Mamchykd, Fabbri
Latest tag: | 2.4.4-2.11.1
Deployment tag: | 2.4.4-2.11.1
Projects: | SPB_SCANTOOL
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock 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.
- 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.4-2.11.1

Created: | 2021-07-01T18:52:35.000Z
Author: | Steffen Hauf
Notes: | Add MC2 subclasses

2.4.3-2.11.1

Created: | 2021-06-28T22:23:24.000Z
Author: | mamchykd
Notes: | Transform functions for motor aNscans, dNscans, mesh and dmesh

2.4.2-2.11.1

Created: | 2021-06-08T15:52:45.000Z
Author: | Riccardo Fabbri
Notes: | Summary: simulatedTrigger tag updated

2.4.1-2.11.1

Created: | 2021-06-03T06:23:54.000Z
Author: | mamchykd
Notes: | Macro async

2.4.0-2.10.0

Created: | 2021-03-22T12:02:09.000Z
Author: | Wajid Ehsan
Notes: | Fixed Data source from the output channel value issue

2.3.9-2.10.0

Created: | 2021-02-23T09:06:06.000Z
Author: | Istvan Mohacsi
Notes: | Summary: Integrate automated alignment extension

2.3.8-2.10.0

Created: | 2021-01-27T18:43:42.000Z
Author: | Wajid Ehsan
Notes: | Include JJAttenuator device into scan tool

2.3.7-2.10.0

Created: | 2021-01-13T15:04:37.000Z
Author: | Istvan Mohacsi
Notes: |

2.3.6-2.10.0

Created: | 2020-11-24T21:22:30.000Z
Author: | Wajid Ehsan
Notes: | update dependency file

2.3.5-2.10.0

Created: | 2020-11-23T12:18:15.000Z
Author: | Istvan Mohacsi
Notes: |

2.3.5-2.9.1

Created: | 2020-10-16T11:50:26.000Z
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-28T10:18:29.000Z
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-04T15:04:30.000Z
Author: | Istvan Mohacsi
Notes: |

2.3.2-2.8.0

Created: | 2020-05-14T11:24:49.000Z
Author: | Istvan Mohacsi
Notes: |

2.3.1-2.8.0

Created: | 2020-04-17T12:19:55.000Z
Author: | Istvan Mohacsi
Notes: |

2.3.0-2.7.2

Created: | 2020-03-03T12:10:32.000Z
Author: | Istvan Mohacsi
Notes: |

2.3.0-2.8.0

Created: | 2020-03-03T12:00:40.000Z
Author: | Istvan Mohacsi
Notes: |

1.6.2-2.6.0

Created: | 2020-02-28T11:16:12.000Z
Author: | Wajid Ehsan
Notes: | add Johann Spectrometer class

2.2.2-2.7.0

Created: | 2020-01-30T13:18:22.000Z
Author: | Istvan Mohacsi
Notes: |

2.2.1-2.7.0

Created: | 2019-12-16T12:53:17.000Z
Author: | Dennis Goeries
Notes: |

##### TSYS

[add component documentation]

###### SIMULATED_TRIGGER

Instance id: | SPB_DAQ_SCAN/TSYS/SIMULATED_TRIGGER
Class id: | SimulatedTrigger
Host: | spb-rr-sys-con-spc
Alias: | spb-rr-sys-con-spc
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/simulatedTrigger
Last modified: | 2021-05-25T11:57:57.000+02:00
Created at: | 2017-11-09T17:34:21.000+01:00
Main authors: | Danilevski, Xctrl, Degon
Latest tag: | 1.1.1-2.10.4
Deployment tag: | 1.1.1-2.10.4
Accessible by: | 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:
    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-25T10:07:21.000Z
Author: | Gero Flucke
Notes: |

1.1.0-2.10.0

Created: | 2020-11-19T14:36:43.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.3.0

Created: | 2018-11-21T17:01:59.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.2.2

Created: | 2018-03-02T14:17:19.000Z
Author: | Dennis Goeries
Notes: |

### DET

[add component documentation]

#### AGIPD1M-1

[add component documentation]

##### CC

[add component documentation]

###### MON_0

Instance id: | SPB_DET_AGIPD1M-1/CC/MON_0
Class id: | Ccmon
Host: | spb-exp-sys-utc-1
Alias: | exflutc109-mch , exflutca109-mch , exflqr19805-mch
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/ccmon
Last modified: | 2021-06-23T17:35:49.000+02:00
Created at: | 2017-03-02T15:01:59.000+01:00
Main authors: | Parenti, Schaffer, Ehsan
Latest tag: | 1.2.5-2.11.1
Deployment tag: | 1.2.5-2.11.1
Installed tag: | 1.2.5-2.11.1
Scenes: | agipd_overview, Clock-and-Control, Clock-and-Control, agipd_overview, Clock and Control , AGIPD control - Firmware tests, agipd_overview, agipd_overview, agipd_compact_monitoring_overview, agipd_overview
Accessible by: | CONTROLS, CTRL, DET, babies, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- 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 true - C&C sync 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_latency:
    Number of clock cycles between receiving the trigger signal and generating FAST/VETO signals.
- 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:
    Defines the source of the VETO parameters.
- veto_num_vetos:
    Number of VETO decisions to read from memory (simulation/Bunch Pattern only).
- 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
- bunchPatternNode:
    Set up bunch pattern decoding parameters

Release History
1.2.5-2.11.1

Created: | 2021-06-23T15:24:40.000Z
Author: | Wajid Ehsan
Notes: | Don’t poll if bunch pattern decoding is not enabled

1.2.4-2.11.1

Created: | 2021-06-15T16:08:50.000Z
Author: | Wajid Ehsan
Notes: | Update Depends tag

1.2.3-2.11.1

Created: | 2021-06-14T13:05:33.000Z
Author: | Wajid Ehsan
Notes: | Add tag for uTCAConfigurations

1.2.2-2.11.1

Created: | 2021-06-09T09:35:28.000Z
Author: | Wajid Ehsan
Notes: | Use tag for iibus related devices

1.2.1-2.11.1

Created: | 2021-06-02T18:23:01.000Z
Author: | Andrea Parenti
Notes: | Feat/v37 + init fixes + Install pciedev_io.h on CI

1.2.0-2.10.0

Created: | 2020-11-23T17:14:00.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.7.1

Created: | 2020-02-18T10:32:07.000Z
Author: | Gabriele Giovanetti
Notes: |

1.2.0-2.7.1-select-backplane-trigger-01

Created: | 2020-02-10T10:43:05.000Z
Author: | Gabriele Giovanetti
Notes: |

1.1.0-2.7.0

Created: | 2020-01-13T14:58:57.000Z
Author: | Gabriele Giovanetti
Notes: | Parameters get timestamp and trainid from local hardware.

1.0.5-2.2.4

Created: | 2018-08-03T09:10:45.000Z
Author: | Alessandro Silenzi
Notes: | minor fix due to name change in C&C firmware project

1.0.4-2.2.3

Created: | 2018-06-14T08:00:10.000Z
Author: | Andrea Parenti
Notes: | Update register names for C&C 4.1.0

1.0.3-2.2.3

Created: | 2018-06-06T09:56:51.000Z
Author: | Andrea Parenti
Notes: | Two fixes to expected paramers

1.0.2-2.2.1

Created: | 2018-02-22T09:59:04.000Z
Author: | Andrea Parenti
Notes: | Fix Netbeans configuration and Makefile for Release mode

1.0.1-2.2.1

Created: | 2018-02-09T13:08:32.000Z
Author: | Andrea Parenti
Notes: | Add 2.1 and 2.2 to KARABO_CLASSINFO

1.0.1-2.1.0

Created: | 2018-01-17T15:33:25.000Z
Author: | esenov
Notes: |

1.0.0-2.1

Created: | 2017-05-15T08:19:36.000Z
Author: | Andrea Parenti
Notes: | AGIPD Squad version

##### CAL

[add component documentation]

###### THRESHOLDING_Q4M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/THRESHOLDING_Q4M4
Class id: | ThresholdingAGIPD
Host: | spb-br-sys-cal-7
Alias: | spb-br-sys-cal-7
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### APPEND_CORRECTED

Instance id: | SPB_DET_AGIPD1M-1/CAL/APPEND_CORRECTED
Class id: | CppFemCombiner
Host: | spb-br-sys-cal-2
Alias: | spb-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/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: | CORRECTED_OVERVIEW, Monitoring, MANAGER_NEW, Monitoring, AGIPD_corrected_preview, AGIPD_calibration_manager, agipd_overview_zoom
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-06T13:15:58.000Z
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T15:28:15.000Z
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

###### APPEND_RAW

Instance id: | SPB_DET_AGIPD1M-1/CAL/APPEND_RAW
Class id: | CppFemCombiner
Host: | spb-br-sys-cal-1
Alias: | spb-br-sys-cal-1
Git repo: | https://git.xfel.eu/gitlab/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, RAW_OVERVIEW, Monitoring, MANAGER_NEW, Monitoring, AGIPD_calibration_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’])!

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-06T13:15:58.000Z
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T15:28:15.000Z
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

###### APPEND_RAW_GAIN

Instance id: | SPB_DET_AGIPD1M-1/CAL/APPEND_RAW_GAIN
Class id: | CppFemCombiner
Host: | spb-br-sys-cal-3
Alias: | spb-br-sys-cal-3
Git repo: | https://git.xfel.eu/gitlab/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, MANAGER_NEW, AGIPD_calibration_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’])!

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-06T13:15:58.000Z
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T15:28:15.000Z
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

###### CAL_MANAGER

Instance id: | SPB_DET_AGIPD1M-1/CAL/CAL_MANAGER
Class id: | CalManager
Host: | spb-br-sys-cal-0
Alias: | spb-br-sys-cal-0
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: | 1.9.0-2.4.1
Scenes: | CORRECTED_OVERVIEW, MANAGER, CORRECTED_OVERVIEW, MANAGER_NEW, agipd_compact_monitoring_overview, AGIPD_calibration_manager, agipd_overview_zoom
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.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

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

###### COMBINE_CORRECTED

Instance id: | SPB_DET_AGIPD1M-1/CAL/COMBINE_CORRECTED
Class id: | FemDataAssembler
Host: | spb-br-sys-cal-2
Alias: | spb-br-sys-cal-2
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: | asf, CORRECTED_OVERVIEW, MANAGER_NEW, IRU_D12_Overview_Old, AGIPD_corrected_preview, IRU_D12_Overview, IRU_D12_Overview_MK_Test, AGIPD_calibration_manager, agipd_overview_zoom, IRU_D12_Overview_Old, IRU_D12_Overview_testMK0, IRU_D12_Overview
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: |

###### COMBINE_RAW

Instance id: | SPB_DET_AGIPD1M-1/CAL/COMBINE_RAW
Class id: | FemDataAssembler
Host: | spb-br-sys-cal-1
Alias: | spb-br-sys-cal-1
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: | RAW_OVERVIEW, RAW_OVERVIEW, MANAGER_NEW, RAW_SIMPLE, AGIPD_calibration_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.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: |

###### COMBINE_RAW_GAIN

Instance id: | SPB_DET_AGIPD1M-1/CAL/COMBINE_RAW_GAIN
Class id: | FemDataAssembler
Host: | spb-br-sys-cal-3
Alias: | spb-br-sys-cal-3
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: | RAW_OVERVIEW, MANAGER_NEW, AGIPD_calibration_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.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: |

###### FEM_SPLITTER_Q1M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q1M1
Class id: | CppFemSplitter
Host: | spb-br-sys-cal-0
Alias: | spb-br-sys-cal-0
Git repo: | https://git.xfel.eu/gitlab/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, agipd_overview, MANAGER, RAW_OVERVIEW, CORRECTED_OVERVIEW, MANAGER_NEW, agipd_overview, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
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
- 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-06T13:15:58.000Z
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T15:28:15.000Z
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q1M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q1M2
Class id: | CppFemSplitter
Host: | spb-br-sys-cal-1
Alias: | spb-br-sys-cal-1
Git repo: | https://git.xfel.eu/gitlab/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, agipd_overview, MANAGER, RAW_OVERVIEW, CORRECTED_OVERVIEW, MANAGER_NEW, agipd_overview, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
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
- 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-06T13:15:58.000Z
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T15:28:15.000Z
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q1M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q1M3
Class id: | CppFemSplitter
Host: | spb-br-sys-cal-2
Alias: | spb-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/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, agipd_overview, MANAGER, RAW_OVERVIEW, CORRECTED_OVERVIEW, MANAGER_NEW, agipd_overview, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
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
- 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-06T13:15:58.000Z
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T15:28:15.000Z
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q1M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q1M4
Class id: | CppFemSplitter
Host: | spb-br-sys-cal-3
Alias: | spb-br-sys-cal-3
Git repo: | https://git.xfel.eu/gitlab/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, agipd_overview, MANAGER, RAW_OVERVIEW, CORRECTED_OVERVIEW, MANAGER_NEW, agipd_overview, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
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
- 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-06T13:15:58.000Z
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T15:28:15.000Z
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q2M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q2M1
Class id: | CppFemSplitter
Host: | spb-br-sys-cal-4
Alias: | spb-br-sys-cal-4
Git repo: | https://git.xfel.eu/gitlab/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, agipd_overview, MANAGER, RAW_OVERVIEW, CORRECTED_OVERVIEW, MANAGER_NEW, agipd_overview, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
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
- 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-06T13:15:58.000Z
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T15:28:15.000Z
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q2M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q2M2
Class id: | CppFemSplitter
Host: | spb-br-sys-cal-5
Alias: | spb-br-sys-cal-5
Git repo: | https://git.xfel.eu/gitlab/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, agipd_overview, MANAGER, RAW_OVERVIEW, CORRECTED_OVERVIEW, MANAGER_NEW, agipd_overview, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
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
- 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-06T13:15:58.000Z
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T15:28:15.000Z
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q2M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q2M3
Class id: | CppFemSplitter
Host: | spb-br-sys-cal-6
Alias: | spb-br-sys-cal-6
Git repo: | https://git.xfel.eu/gitlab/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, agipd_overview, MANAGER, RAW_OVERVIEW, CORRECTED_OVERVIEW, MANAGER_NEW, agipd_overview, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
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
- 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-06T13:15:58.000Z
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T15:28:15.000Z
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q2M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q2M4
Class id: | CppFemSplitter
Host: | spb-br-sys-cal-7
Alias: | spb-br-sys-cal-7
Git repo: | https://git.xfel.eu/gitlab/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, agipd_overview, MANAGER, RAW_OVERVIEW, CORRECTED_OVERVIEW, MANAGER_NEW, agipd_overview, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
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
- 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-06T13:15:58.000Z
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T15:28:15.000Z
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q3M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q3M1
Class id: | CppFemSplitter
Host: | spb-br-sys-cal-0
Alias: | spb-br-sys-cal-0
Git repo: | https://git.xfel.eu/gitlab/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, agipd_overview, MANAGER, RAW_OVERVIEW, CORRECTED_OVERVIEW, MANAGER_NEW, agipd_overview, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
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
- 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-06T13:15:58.000Z
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T15:28:15.000Z
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q3M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q3M2
Class id: | CppFemSplitter
Host: | spb-br-sys-cal-1
Alias: | spb-br-sys-cal-1
Git repo: | https://git.xfel.eu/gitlab/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, agipd_overview, MANAGER, RAW_OVERVIEW, CORRECTED_OVERVIEW, MANAGER_NEW, agipd_overview, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
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
- 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-06T13:15:58.000Z
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T15:28:15.000Z
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q3M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q3M3
Class id: | CppFemSplitter
Host: | spb-br-sys-cal-2
Alias: | spb-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/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, agipd_overview, MANAGER, RAW_OVERVIEW, CORRECTED_OVERVIEW, MANAGER_NEW, agipd_overview, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
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
- 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-06T13:15:58.000Z
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T15:28:15.000Z
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q3M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q3M4
Class id: | CppFemSplitter
Host: | spb-br-sys-cal-3
Alias: | spb-br-sys-cal-3
Git repo: | https://git.xfel.eu/gitlab/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, agipd_overview, MANAGER, RAW_OVERVIEW, CORRECTED_OVERVIEW, MANAGER_NEW, agipd_overview, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
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
- 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-06T13:15:58.000Z
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T15:28:15.000Z
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q4M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q4M1
Class id: | CppFemSplitter
Host: | spb-br-sys-cal-4
Alias: | spb-br-sys-cal-4
Git repo: | https://git.xfel.eu/gitlab/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, agipd_overview, MANAGER, RAW_OVERVIEW, CORRECTED_OVERVIEW, MANAGER_NEW, agipd_overview, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
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
- 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-06T13:15:58.000Z
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T15:28:15.000Z
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q4M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q4M2
Class id: | CppFemSplitter
Host: | spb-br-sys-cal-5
Alias: | spb-br-sys-cal-5
Git repo: | https://git.xfel.eu/gitlab/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, agipd_overview, MANAGER, RAW_OVERVIEW, CORRECTED_OVERVIEW, MANAGER_NEW, agipd_overview, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
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
- 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-06T13:15:58.000Z
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T15:28:15.000Z
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q4M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q4M3
Class id: | CppFemSplitter
Host: | spb-br-sys-cal-6
Alias: | spb-br-sys-cal-6
Git repo: | https://git.xfel.eu/gitlab/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, agipd_overview, MANAGER, RAW_OVERVIEW, CORRECTED_OVERVIEW, MANAGER_NEW, agipd_overview, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
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
- 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-06T13:15:58.000Z
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T15:28:15.000Z
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

###### FEM_SPLITTER_Q4M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/FEM_SPLITTER_Q4M4
Class id: | CppFemSplitter
Host: | spb-br-sys-cal-7
Alias: | spb-br-sys-cal-7
Git repo: | https://git.xfel.eu/gitlab/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, agipd_overview, MANAGER, RAW_OVERVIEW, CORRECTED_OVERVIEW, MANAGER_NEW, agipd_overview, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
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
- 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-06T13:15:58.000Z
Author: | Cyril Danilevski
Notes: |

1.4.3-2.10.0-test

Created: | 2020-11-23T15:28:15.000Z
Author: | Steffen Hauf
Notes: |

1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

###### INIT

Instance id: | SPB_DET_AGIPD1M-1/CAL/INIT
Class id: | InitAgipdOnlineCorrection
Host: | spb-br-sys-cal-0
Class documentation:
| InitAgipdOnlineCorrection
Alias: | spb-br-sys-cal-0
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calML
Last modified: | 2021-06-22T13:46:07.000+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: | MANAGER, CORRECTED_OVERVIEW, MANAGER_NEW, agipd_compact_monitoring_overview, AGIPD_corrected_preview, AGIPD_calibration_manager, agipd_overview_zoom
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’])!

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-17T08:27:01.000Z
Author: | Cyril Danilevski
Notes: | Update LPD init device with new correction devices.

2.4.0-2.10.0

Created: | 2021-04-12T11:55:22.000Z
Author: | Karim Ahmed
Notes: |

2.3.0-2.10.0

Created: | 2021-02-24T14:47:57.000Z
Author: | Karim Ahmed
Notes: | Add support for CalCat Mapping

2.3.0-2.10.0-test

Created: | 2021-02-23T12:18:42.000Z
Author: | Karim Ahmed
Notes: | New CalCat Mapping

2.1-2.10.0-test

Created: | 2020-11-25T11:55:29.000Z
Author: | haufs
Notes: |

2.2.1-2.10.0

Created: | 2020-11-16T17:13:18.000Z
Author: | Cyril Danilevski
Notes: |

2.2.0-2.10.0-test

Created: | 2020-11-16T17:13:18.000Z
Author: | Cyril Danilevski
Notes: | For early 2.10 tests

2.2.0-2.9.1

Created: | 2020-10-21T14:21:10.000Z
Author: | Karim Ahmed
Notes: |

2.1.2-2.9.1-fixSplitterFilter

Created: | 2020-09-28T17:32:59.000Z
Author: | Thomas Michelat
Notes: |

2.1.2-2.9.1

Created: | 2020-08-14T12:55:05.000Z
Author: | Thomas Michelat
Notes: | Update default configuration for DSSC

2.1.1-2.9.1

Created: | 2020-07-08T11:46:27.000Z
Author: | Thomas Michelat
Notes: | FIX verify config

2.1-2.7.1

Created: | 2020-04-06T13:46:47.000Z
Author: | Mikhail Karnevskiy
Notes: |

2.0-2.7.1

Created: | 2020-01-31T09:55:39.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.9-2.5.1

Created: | 2019-08-27T11:44:22.000Z
Author: | Steffen Hauf
Notes: |

1.8-2.5.1

Created: | 2019-07-30T13:46:44.000Z
Author: | Steffen Hauf
Notes: |

1.7-2.5.1

Created: | 2019-07-30T13:24:49.000Z
Author: | Steffen Hauf
Notes: |

1.6-2.4.1

Created: | 2019-07-12T08:40:29.000Z
Author: | Steffen Hauf
Notes: |

1.5-2.4.1

Created: | 2019-07-02T09:10:31.000Z
Author: | Steffen Hauf
Notes: |

1.4-2.4.1

Created: | 2019-05-16T10:01:01.000Z
Author: | Steffen Hauf
Notes: |

1.3-2.4.1

Created: | 2019-05-09T17:22:28.000Z
Author: | Steffen Hauf
Notes: |

###### MGAIN_CORR_Q1M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q1M1
Class id: | MGainLevelerAGIPD
Host: | spb-br-sys-cal-0
Alias: | spb-br-sys-cal-0
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### MGAIN_CORR_Q1M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q1M2
Class id: | MGainLevelerAGIPD
Host: | spb-br-sys-cal-1
Alias: | spb-br-sys-cal-1
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### MGAIN_CORR_Q1M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q1M3
Class id: | MGainLevelerAGIPD
Host: | spb-br-sys-cal-2
Alias: | spb-br-sys-cal-2
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### MGAIN_CORR_Q1M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q1M4
Class id: | MGainLevelerAGIPD
Host: | spb-br-sys-cal-3
Alias: | spb-br-sys-cal-3
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### MGAIN_CORR_Q2M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q2M1
Class id: | MGainLevelerAGIPD
Host: | spb-br-sys-cal-4
Alias: | spb-br-sys-cal-4
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### MGAIN_CORR_Q2M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q2M2
Class id: | MGainLevelerAGIPD
Host: | spb-br-sys-cal-5
Alias: | spb-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: | MANAGER_NEW, AGIPD_calibration_manager
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

###### MGAIN_CORR_Q2M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q2M3
Class id: | MGainLevelerAGIPD
Host: | spb-br-sys-cal-6
Alias: | spb-br-sys-cal-6
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### MGAIN_CORR_Q2M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q2M4
Class id: | MGainLevelerAGIPD
Host: | spb-br-sys-cal-7
Alias: | spb-br-sys-cal-7
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### MGAIN_CORR_Q3M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q3M1
Class id: | MGainLevelerAGIPD
Host: | spb-br-sys-cal-0
Alias: | spb-br-sys-cal-0
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### MGAIN_CORR_Q3M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q3M2
Class id: | MGainLevelerAGIPD
Host: | spb-br-sys-cal-1
Alias: | spb-br-sys-cal-1
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### MGAIN_CORR_Q3M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q3M3
Class id: | MGainLevelerAGIPD
Host: | spb-br-sys-cal-2
Alias: | spb-br-sys-cal-2
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### MGAIN_CORR_Q3M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q3M4
Class id: | MGainLevelerAGIPD
Host: | spb-br-sys-cal-3
Alias: | spb-br-sys-cal-3
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### MGAIN_CORR_Q4M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q4M1
Class id: | MGainLevelerAGIPD
Host: | spb-br-sys-cal-4
Alias: | spb-br-sys-cal-4
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### MGAIN_CORR_Q4M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q4M2
Class id: | MGainLevelerAGIPD
Host: | spb-br-sys-cal-5
Alias: | spb-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: | MANAGER_NEW, AGIPD_calibration_manager
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

###### MGAIN_CORR_Q4M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q4M3
Class id: | MGainLevelerAGIPD
Host: | spb-br-sys-cal-6
Alias: | spb-br-sys-cal-6
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### MGAIN_CORR_Q4M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/MGAIN_CORR_Q4M4
Class id: | MGainLevelerAGIPD
Host: | spb-br-sys-cal-7
Alias: | spb-br-sys-cal-7
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### OFFSET_CORR_Q1M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q1M1
Class id: | OffsetCorrectionAGIPD
Host: | spb-br-sys-cal-0
Alias: | spb-br-sys-cal-0
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### OFFSET_CORR_Q1M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q1M2
Class id: | OffsetCorrectionAGIPD
Host: | spb-br-sys-cal-1
Alias: | spb-br-sys-cal-1
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### OFFSET_CORR_Q1M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q1M3
Class id: | OffsetCorrectionAGIPD
Host: | spb-br-sys-cal-2
Alias: | spb-br-sys-cal-2
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### OFFSET_CORR_Q1M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q1M4
Class id: | OffsetCorrectionAGIPD
Host: | spb-br-sys-cal-3
Alias: | spb-br-sys-cal-3
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### OFFSET_CORR_Q2M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q2M1
Class id: | OffsetCorrectionAGIPD
Host: | spb-br-sys-cal-4
Alias: | spb-br-sys-cal-4
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### OFFSET_CORR_Q2M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q2M2
Class id: | OffsetCorrectionAGIPD
Host: | spb-br-sys-cal-5
Alias: | spb-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: | MANAGER_NEW, AGIPD_calibration_manager
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

###### OFFSET_CORR_Q2M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q2M3
Class id: | OffsetCorrectionAGIPD
Host: | spb-br-sys-cal-6
Alias: | spb-br-sys-cal-6
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### OFFSET_CORR_Q2M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q2M4
Class id: | OffsetCorrectionAGIPD
Host: | spb-br-sys-cal-7
Alias: | spb-br-sys-cal-7
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### OFFSET_CORR_Q3M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q3M1
Class id: | OffsetCorrectionAGIPD
Host: | spb-br-sys-cal-0
Alias: | spb-br-sys-cal-0
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### OFFSET_CORR_Q3M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q3M2
Class id: | OffsetCorrectionAGIPD
Host: | spb-br-sys-cal-1
Alias: | spb-br-sys-cal-1
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### OFFSET_CORR_Q3M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q3M3
Class id: | OffsetCorrectionAGIPD
Host: | spb-br-sys-cal-2
Alias: | spb-br-sys-cal-2
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### OFFSET_CORR_Q3M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q3M4
Class id: | OffsetCorrectionAGIPD
Host: | spb-br-sys-cal-3
Alias: | spb-br-sys-cal-3
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### OFFSET_CORR_Q4M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q4M1
Class id: | OffsetCorrectionAGIPD
Host: | spb-br-sys-cal-4
Alias: | spb-br-sys-cal-4
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### OFFSET_CORR_Q4M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q4M2
Class id: | OffsetCorrectionAGIPD
Host: | spb-br-sys-cal-5
Alias: | spb-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: | MANAGER_NEW, AGIPD_calibration_manager
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

###### OFFSET_CORR_Q4M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q4M3
Class id: | OffsetCorrectionAGIPD
Host: | spb-br-sys-cal-6
Alias: | spb-br-sys-cal-6
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### OFFSET_CORR_Q4M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/OFFSET_CORR_Q4M4
Class id: | OffsetCorrectionAGIPD
Host: | spb-br-sys-cal-7
Alias: | spb-br-sys-cal-7
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### RELGAIN_CORR_Q1M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q1M1
Class id: | RelativeGainCorrection
Host: | spb-br-sys-cal-0
Alias: | spb-br-sys-cal-0
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### RELGAIN_CORR_Q1M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q1M2
Class id: | RelativeGainCorrection
Host: | spb-br-sys-cal-1
Alias: | spb-br-sys-cal-1
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### RELGAIN_CORR_Q1M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q1M3
Class id: | RelativeGainCorrection
Host: | spb-br-sys-cal-2
Alias: | spb-br-sys-cal-2
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### RELGAIN_CORR_Q1M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q1M4
Class id: | RelativeGainCorrection
Host: | spb-br-sys-cal-3
Alias: | spb-br-sys-cal-3
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### RELGAIN_CORR_Q2M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q2M1
Class id: | RelativeGainCorrection
Host: | spb-br-sys-cal-4
Alias: | spb-br-sys-cal-4
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### RELGAIN_CORR_Q2M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q2M2
Class id: | RelativeGainCorrection
Host: | spb-br-sys-cal-5
Alias: | spb-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: | MANAGER_NEW, AGIPD_calibration_manager
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

###### RELGAIN_CORR_Q2M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q2M3
Class id: | RelativeGainCorrection
Host: | spb-br-sys-cal-6
Alias: | spb-br-sys-cal-6
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### RELGAIN_CORR_Q2M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q2M4
Class id: | RelativeGainCorrection
Host: | spb-br-sys-cal-7
Alias: | spb-br-sys-cal-7
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### RELGAIN_CORR_Q3M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q3M1
Class id: | RelativeGainCorrection
Host: | spb-br-sys-cal-0
Alias: | spb-br-sys-cal-0
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### RELGAIN_CORR_Q3M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q3M2
Class id: | RelativeGainCorrection
Host: | spb-br-sys-cal-1
Alias: | spb-br-sys-cal-1
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### RELGAIN_CORR_Q3M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q3M3
Class id: | RelativeGainCorrection
Host: | spb-br-sys-cal-2
Alias: | spb-br-sys-cal-2
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### RELGAIN_CORR_Q3M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q3M4
Class id: | RelativeGainCorrection
Host: | spb-br-sys-cal-3
Alias: | spb-br-sys-cal-3
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### RELGAIN_CORR_Q4M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q4M1
Class id: | RelativeGainCorrection
Host: | spb-br-sys-cal-4
Alias: | spb-br-sys-cal-4
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### RELGAIN_CORR_Q4M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q4M2
Class id: | RelativeGainCorrection
Host: | spb-br-sys-cal-5
Alias: | spb-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: | MANAGER_NEW, AGIPD_calibration_manager
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

###### RELGAIN_CORR_Q4M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q4M3
Class id: | RelativeGainCorrection
Host: | spb-br-sys-cal-6
Alias: | spb-br-sys-cal-6
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### RELGAIN_CORR_Q4M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/RELGAIN_CORR_Q4M4
Class id: | RelativeGainCorrection
Host: | spb-br-sys-cal-7
Alias: | spb-br-sys-cal-7
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### RESTART

Instance id: | SPB_DET_AGIPD1M-1/CAL/RESTART
Class id: | RestartCalServers
Host: | spb-br-sys-cal-0
Alias: | spb-br-sys-cal-0
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calML
Last modified: | 2021-06-22T13:46:07.000+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: | MANAGER, MANAGER_NEW, AGIPD_calibration_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’])!

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-17T08:27:01.000Z
Author: | Cyril Danilevski
Notes: | Update LPD init device with new correction devices.

2.4.0-2.10.0

Created: | 2021-04-12T11:55:22.000Z
Author: | Karim Ahmed
Notes: |

2.3.0-2.10.0

Created: | 2021-02-24T14:47:57.000Z
Author: | Karim Ahmed
Notes: | Add support for CalCat Mapping

2.3.0-2.10.0-test

Created: | 2021-02-23T12:18:42.000Z
Author: | Karim Ahmed
Notes: | New CalCat Mapping

2.1-2.10.0-test

Created: | 2020-11-25T11:55:29.000Z
Author: | haufs
Notes: |

2.2.1-2.10.0

Created: | 2020-11-16T17:13:18.000Z
Author: | Cyril Danilevski
Notes: |

2.2.0-2.10.0-test

Created: | 2020-11-16T17:13:18.000Z
Author: | Cyril Danilevski
Notes: | For early 2.10 tests

2.2.0-2.9.1

Created: | 2020-10-21T14:21:10.000Z
Author: | Karim Ahmed
Notes: |

2.1.2-2.9.1-fixSplitterFilter

Created: | 2020-09-28T17:32:59.000Z
Author: | Thomas Michelat
Notes: |

2.1.2-2.9.1

Created: | 2020-08-14T12:55:05.000Z
Author: | Thomas Michelat
Notes: | Update default configuration for DSSC

2.1.1-2.9.1

Created: | 2020-07-08T11:46:27.000Z
Author: | Thomas Michelat
Notes: | FIX verify config

2.1-2.7.1

Created: | 2020-04-06T13:46:47.000Z
Author: | Mikhail Karnevskiy
Notes: |

2.0-2.7.1

Created: | 2020-01-31T09:55:39.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.9-2.5.1

Created: | 2019-08-27T11:44:22.000Z
Author: | Steffen Hauf
Notes: |

1.8-2.5.1

Created: | 2019-07-30T13:46:44.000Z
Author: | Steffen Hauf
Notes: |

1.7-2.5.1

Created: | 2019-07-30T13:24:49.000Z
Author: | Steffen Hauf
Notes: |

1.6-2.4.1

Created: | 2019-07-12T08:40:29.000Z
Author: | Steffen Hauf
Notes: |

1.5-2.4.1

Created: | 2019-07-02T09:10:31.000Z
Author: | Steffen Hauf
Notes: |

1.4-2.4.1

Created: | 2019-05-16T10:01:01.000Z
Author: | Steffen Hauf
Notes: |

1.3-2.4.1

Created: | 2019-05-09T17:22:28.000Z
Author: | Steffen Hauf
Notes: |

###### THRESHOLDING_Q1M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/THRESHOLDING_Q1M1
Class id: | ThresholdingAGIPD
Host: | spb-br-sys-cal-0
Alias: | spb-br-sys-cal-0
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### THRESHOLDING_Q1M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/THRESHOLDING_Q1M2
Class id: | ThresholdingAGIPD
Host: | spb-br-sys-cal-1
Alias: | spb-br-sys-cal-1
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### THRESHOLDING_Q1M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/THRESHOLDING_Q1M3
Class id: | ThresholdingAGIPD
Host: | spb-br-sys-cal-2
Alias: | spb-br-sys-cal-2
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### THRESHOLDING_Q1M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/THRESHOLDING_Q1M4
Class id: | ThresholdingAGIPD
Host: | spb-br-sys-cal-3
Alias: | spb-br-sys-cal-3
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### THRESHOLDING_Q2M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/THRESHOLDING_Q2M1
Class id: | ThresholdingAGIPD
Host: | spb-br-sys-cal-4
Alias: | spb-br-sys-cal-4
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### THRESHOLDING_Q2M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/THRESHOLDING_Q2M2
Class id: | ThresholdingAGIPD
Host: | spb-br-sys-cal-5
Alias: | spb-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: | MANAGER_NEW, AGIPD_calibration_manager
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

###### THRESHOLDING_Q2M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/THRESHOLDING_Q2M3
Class id: | ThresholdingAGIPD
Host: | spb-br-sys-cal-6
Alias: | spb-br-sys-cal-6
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### THRESHOLDING_Q2M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/THRESHOLDING_Q2M4
Class id: | ThresholdingAGIPD
Host: | spb-br-sys-cal-7
Alias: | spb-br-sys-cal-7
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### THRESHOLDING_Q3M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/THRESHOLDING_Q3M1
Class id: | ThresholdingAGIPD
Host: | spb-br-sys-cal-0
Alias: | spb-br-sys-cal-0
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### THRESHOLDING_Q3M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/THRESHOLDING_Q3M2
Class id: | ThresholdingAGIPD
Host: | spb-br-sys-cal-1
Alias: | spb-br-sys-cal-1
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### THRESHOLDING_Q3M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/THRESHOLDING_Q3M3
Class id: | ThresholdingAGIPD
Host: | spb-br-sys-cal-2
Alias: | spb-br-sys-cal-2
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### THRESHOLDING_Q3M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/THRESHOLDING_Q3M4
Class id: | ThresholdingAGIPD
Host: | spb-br-sys-cal-3
Alias: | spb-br-sys-cal-3
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### THRESHOLDING_Q4M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/THRESHOLDING_Q4M1
Class id: | ThresholdingAGIPD
Host: | spb-br-sys-cal-4
Alias: | spb-br-sys-cal-4
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### THRESHOLDING_Q4M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/THRESHOLDING_Q4M2
Class id: | ThresholdingAGIPD
Host: | spb-br-sys-cal-5
Alias: | spb-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: | MANAGER_NEW, AGIPD_calibration_manager
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

###### THRESHOLDING_Q4M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/THRESHOLDING_Q4M3
Class id: | ThresholdingAGIPD
Host: | spb-br-sys-cal-6
Alias: | spb-br-sys-cal-6
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: | 1.9.0-2.4.1
Scenes: | MANAGER_NEW, AGIPD_calibration_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.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

###### BPMASK_CORR_Q1M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q1M1
Class id: | MaskBadPixels
Host: | spb-br-sys-cal-0
Alias: | spb-br-sys-cal-0
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: | 1.9.0-2.4.1
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.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

###### BPMASK_CORR_Q1M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q1M2
Class id: | MaskBadPixels
Host: | spb-br-sys-cal-1
Alias: | spb-br-sys-cal-1
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: | 1.9.0-2.4.1
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.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

###### BPMASK_CORR_Q1M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q1M3
Class id: | MaskBadPixels
Host: | spb-br-sys-cal-2
Alias: | spb-br-sys-cal-2
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: | 1.9.0-2.4.1
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.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

###### BPMASK_CORR_Q1M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q1M4
Class id: | MaskBadPixels
Host: | spb-br-sys-cal-3
Alias: | spb-br-sys-cal-3
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: | 1.9.0-2.4.1
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.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

###### BPMASK_CORR_Q2M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q2M1
Class id: | MaskBadPixels
Host: | spb-br-sys-cal-4
Alias: | spb-br-sys-cal-4
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: | 1.9.0-2.4.1
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.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

###### BPMASK_CORR_Q2M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q2M2
Class id: | MaskBadPixels
Host: | spb-br-sys-cal-5
Alias: | spb-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
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

###### BPMASK_CORR_Q2M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q2M3
Class id: | MaskBadPixels
Host: | spb-br-sys-cal-6
Alias: | spb-br-sys-cal-6
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: | 1.9.0-2.4.1
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.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

###### BPMASK_CORR_Q2M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q2M4
Class id: | MaskBadPixels
Host: | spb-br-sys-cal-7
Alias: | spb-br-sys-cal-7
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: | 1.9.0-2.4.1
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.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

###### BPMASK_CORR_Q3M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q3M1
Class id: | MaskBadPixels
Host: | spb-br-sys-cal-0
Alias: | spb-br-sys-cal-0
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: | 1.9.0-2.4.1
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.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

###### BPMASK_CORR_Q3M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q3M2
Class id: | MaskBadPixels
Host: | spb-br-sys-cal-1
Alias: | spb-br-sys-cal-1
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: | 1.9.0-2.4.1
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.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

###### BPMASK_CORR_Q3M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q3M3
Class id: | MaskBadPixels
Host: | spb-br-sys-cal-2
Alias: | spb-br-sys-cal-2
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: | 1.9.0-2.4.1
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.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

###### BPMASK_CORR_Q3M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q3M4
Class id: | MaskBadPixels
Host: | spb-br-sys-cal-3
Alias: | spb-br-sys-cal-3
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: | 1.9.0-2.4.1
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.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

###### BPMASK_CORR_Q4M1

Instance id: | SPB_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q4M1
Class id: | MaskBadPixels
Host: | spb-br-sys-cal-4
Alias: | spb-br-sys-cal-4
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: | 1.9.0-2.4.1
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.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

###### BPMASK_CORR_Q4M2

Instance id: | SPB_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q4M2
Class id: | MaskBadPixels
Host: | spb-br-sys-cal-5
Alias: | spb-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
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

###### BPMASK_CORR_Q4M3

Instance id: | SPB_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q4M3
Class id: | MaskBadPixels
Host: | spb-br-sys-cal-6
Alias: | spb-br-sys-cal-6
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: | 1.9.0-2.4.1
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.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

###### BPMASK_CORR_Q4M4

Instance id: | SPB_DET_AGIPD1M-1/CAL/BPMASK_CORR_Q4M4
Class id: | MaskBadPixels
Host: | spb-br-sys-cal-7
Alias: | spb-br-sys-cal-7
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: | 1.9.0-2.4.1
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.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

##### CCML

###### VETO

Instance id: | SPB_DET_AGIPD1M-1/CCML/VETO
Class id: | ClockAndControlML
Host: | spb-exp-sys-utc-1
Alias: | exflutc109-mch , exflutca109-mch , exflqr19805-mch
Git repo: | https://git.xfel.eu/gitlab/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
Scenes: | Clock-and-Control, Clock-and-Control, Clock and Control , AGIPD control - Firmware tests
Accessible by: | CONTROLS, CTRL, DET, babies, 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
- 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-06T11:23:24.000Z
Author: | Cyril Danilevski
Notes: |

1.2.0-2.10.0

Created: | 2020-11-23T17:16:33.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.2.4

Created: | 2018-06-27T12:36:03.000Z
Author: | Gabriele Giovanetti
Notes: | Set DAQ policies

1.1.1-2.2.1

Created: | 2018-01-29T14:47:28.000Z
Author: | Cyril Danilevski
Notes: |

1.1.0-2.2.0

Created: | 2017-12-20T16:25:03.000Z
Author: | Cyril Danilevski
Notes: |

1.1.0-2.1.18

Created: | 2017-12-20T16:25:03.000Z
Author: | Cyril Danilevski
Notes: |

1.0.1-2.1.12

Created: | 2017-08-17T08:42:30.000Z
Author: | Cyril Danilevski
Notes: | Fixes the indexing of bunches

1.0.0-2.1.12

Created: | 2017-07-24T09:26:55.000Z
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)

##### ZEROMQ

###### CORR

Instance id: | SPB_DET_AGIPD1M-1/ZEROMQ/CORR
Class id: | PipeToZeroMQ
Host: | exflonc01
Alias: | la1-br-kc-comp-1 , sa1-br-kc-comp-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-11-20T21:40:07.000+01:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Dall’antonia, Michelat, Silenzi
Latest tag: | 3.2.4-2.10.0
Deployment tag: | 3.2.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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
- addressOutput1:
    Address to use to get data from this output
- data_sent1:
    Count total of train data sent on this output
- addressOutput2:
    Address to use to get data from this output
- data_sent2:
    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: |

###### RAW

Instance id: | SPB_DET_AGIPD1M-1/ZEROMQ/RAW
Class id: | PipeToZeroMQ
Host: | exflonc01
Alias: | la1-br-kc-comp-1 , sa1-br-kc-comp-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-11-20T21:40:07.000+01:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Dall’antonia, Michelat, Silenzi
Latest tag: | 3.2.4-2.10.0
Deployment tag: | 3.2.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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: |

##### PROC

[add component documentation]

###### ADU_MON_1

Instance id: | SPB_DET_AGIPD1M-1/PROC/ADU_MON_1
Class id: | AgipdAduHistogram
Host: | sa1-br-kc-comp-1
Alias: | sa1-br-kc-comp-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/agipdAduHistogram
Last modified: | 2020-11-23T15:53:32.000+01:00
Created at: | 2019-09-16T14:38:05.000+02:00
Main authors: | Dall’antonia, Haufs
Latest tag: | 1.1.0-2.10.0
Deployment tag: | 1.1.0-2.10.0
Installed tag: | 1.1.0-2.10.0
Scenes: | CORRECTED_OVERVIEW
Accessible by: | CAL, CONTROLS, CTRL, DA, amunnich, danilevc, jsztuk, kirkwood, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- userMask:
    Path to file with static mask, shape (16, 512, 128)
- buffer:
    last N elements of trend data to be stored/shown
- start:
    Start device for train processing.
- source:
    Defines data source, in case of file-data: module
- fileFormat:
    If true, module # below will be ignored
- module:
    Index to select module from all data (online only)
- pulse1:
    Index used to select POI from each train
- pulse2:
    Index used to select a compared pulse
- roi1:
    (x1, x2, y1, y2) bounding box for ROI 1
- roi2:
    (x1, x2, y1, y2) bounding box for ROI 2
- conversion:
    Conversion factor relating photons to ADU.
- intensity0:
    Used to subtract from ROI levels before ratio
- threshold:
    Used to truncate pixel ADUs to zero below peak
- avWin:
    Used for smooth trend lines
- track:
    Do Gauss-fit-based image processing to track peak
- mask:
    Restrict all-module image display to ROI1
- stop:
    Stop train processing by the device.
- counter:
    Counting received and processed trains.
- purge:
    Clear all trend-line data

Release History
1.1.0-2.10.0

Created: | 2020-11-23T14:53:30.000Z
Author: | Fabio Dall’Antonia
Notes: |

1.0.1-2.9.1

Created: | 2020-10-27T13:43:35.000Z
Author: | Fabio Dall’Antonia
Notes: | Fix import error for the Karabo-internal dependency

1.0.0-2.9.1

Created: | 2020-10-27T12:25:13.000Z
Author: | Fabio Dall’Antonia
Notes: |

##### DET

[add component documentation]

###### 0CH0

Instance id: | SPB_DET_AGIPD1M-1/DET/0CH0
Class id: | DataAggregator
Host: | spb-br-sys-daq-0
Alias: | spb-br-sys-daq-0
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Projects: | AGIPD_DAQ, SPB_RUN_MANAGEMENT, CAMERAs, MAIN_copy
Scenes: | SPB_DAQ_STATUS, SPB_RUN_CONTROL_2-OBSOLETE, Run Control (v2), agipd_overview, SPB_DAQ_STATUS-OBSOLETE, CORRECTED_OVERVIEW, DAQ_RunControl_v2, MANAGER_NEW, DAQ_RunControl, agipd_overview, agipd_overview, FPGAConfiguration, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### 10CH0

Instance id: | SPB_DET_AGIPD1M-1/DET/10CH0
Class id: | DataAggregator
Host: | spb-br-sys-daq-10
Alias: | spb-br-sys-daq-10
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Projects: | AGIPD_DAQ, SPB_RUN_MANAGEMENT, CAMERAs, MAIN_copy
Scenes: | SPB_DAQ_STATUS, SPB_RUN_CONTROL_2-OBSOLETE, agipd_overview, SPB_DAQ_STATUS-OBSOLETE, CORRECTED_OVERVIEW, DAQ_RunControl_v2, MANAGER_NEW, DAQ_RunControl, agipd_overview, agipd_overview, FPGAConfiguration, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### 11CH0

Instance id: | SPB_DET_AGIPD1M-1/DET/11CH0
Class id: | DataAggregator
Host: | spb-br-sys-daq-11
Alias: | spb-br-sys-daq-11
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Projects: | AGIPD_DAQ, SPB_RUN_MANAGEMENT, CAMERAs, MAIN_copy
Scenes: | SPB_DAQ_STATUS, SPB_RUN_CONTROL_2-OBSOLETE, agipd_overview, SPB_DAQ_STATUS-OBSOLETE, CORRECTED_OVERVIEW, DAQ_RunControl_v2, MANAGER_NEW, DAQ_RunControl, agipd_overview, agipd_overview, FPGAConfiguration, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### 12CH0

Instance id: | SPB_DET_AGIPD1M-1/DET/12CH0
Class id: | DataAggregator
Host: | spb-br-sys-daq-12
Alias: | spb-br-sys-daq-12
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Projects: | AGIPD_DAQ, SPB_RUN_MANAGEMENT, CAMERAs, MAIN_copy
Scenes: | SPB_DAQ_STATUS, SPB_RUN_CONTROL_2-OBSOLETE, agipd_overview, SPB_DAQ_STATUS-OBSOLETE, CORRECTED_OVERVIEW, DAQ_RunControl_v2, MANAGER_NEW, DAQ_RunControl, agipd_overview, agipd_overview, FPGAConfiguration, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### 13CH0

Instance id: | SPB_DET_AGIPD1M-1/DET/13CH0
Class id: | DataAggregator
Host: | spb-br-sys-daq-13
Alias: | spb-br-sys-daq-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Projects: | AGIPD_DAQ, SPB_RUN_MANAGEMENT, CAMERAs, MAIN_copy
Scenes: | SPB_DAQ_STATUS, SPB_RUN_CONTROL_2-OBSOLETE, agipd_overview, SPB_DAQ_STATUS-OBSOLETE, CORRECTED_OVERVIEW, DAQ_RunControl_v2, MANAGER_NEW, DAQ_RunControl, agipd_overview, agipd_overview, FPGAConfiguration, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### 14CH0

Instance id: | SPB_DET_AGIPD1M-1/DET/14CH0
Class id: | DataAggregator
Host: | spb-br-sys-daq-14
Alias: | spb-br-sys-daq-14
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Projects: | AGIPD_DAQ, SPB_RUN_MANAGEMENT, CAMERAs, MAIN_copy
Scenes: | SPB_DAQ_STATUS, SPB_RUN_CONTROL_2-OBSOLETE, agipd_overview, SPB_DAQ_STATUS-OBSOLETE, CORRECTED_OVERVIEW, DAQ_RunControl_v2, MANAGER_NEW, DAQ_RunControl, agipd_overview, agipd_overview, FPGAConfiguration, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### 15CH0

Instance id: | SPB_DET_AGIPD1M-1/DET/15CH0
Class id: | DataAggregator
Host: | spb-br-sys-daq-15
Alias: | spb-br-sys-daq-15
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Projects: | AGIPD_DAQ, SPB_RUN_MANAGEMENT, CAMERAs, MAIN_copy
Scenes: | SPB_DAQ_STATUS, SPB_RUN_CONTROL_2-OBSOLETE, agipd_overview, SPB_DAQ_STATUS-OBSOLETE, CORRECTED_OVERVIEW, DAQ_RunControl_v2, MANAGER_NEW, DAQ_RunControl, agipd_overview, agipd_overview, FPGAConfiguration, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### 16CH0

Instance id: | SPB_DET_AGIPD1M-1/DET/16CH0
Class id: | DataAggregator
Host: | spb-br-sys-daq-16
Alias: | spb-br-sys-daq-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Scenes: | SPB_DAQ_STATUS-OBSOLETE, agipg64k_online_preview, overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### 7CH0

Instance id: | SPB_DET_AGIPD1M-1/DET/7CH0
Class id: | DataAggregator
Host: | spb-br-sys-daq-7
Alias: | spb-br-sys-daq-7
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Projects: | AGIPD_DAQ, SPB_RUN_MANAGEMENT, CAMERAs, MAIN_copy
Scenes: | SPB_DAQ_STATUS, SPB_RUN_CONTROL_2-OBSOLETE, agipd_overview, SPB_DAQ_STATUS-OBSOLETE, CORRECTED_OVERVIEW, DAQ_RunControl_v2, MANAGER_NEW, DAQ_RunControl, agipd_overview, agipd_overview, FPGAConfiguration, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### 8CH0

Instance id: | SPB_DET_AGIPD1M-1/DET/8CH0
Class id: | DataAggregator
Host: | spb-br-sys-daq-8
Alias: | spb-br-sys-daq-8
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Projects: | AGIPD_DAQ, SPB_RUN_MANAGEMENT, CAMERAs, MAIN_copy
Scenes: | SPB_DAQ_STATUS, SPB_RUN_CONTROL_2-OBSOLETE, agipd_overview, SPB_DAQ_STATUS-OBSOLETE, CORRECTED_OVERVIEW, DAQ_RunControl_v2, MANAGER_NEW, DAQ_RunControl, agipd_overview, agipd_overview, FPGAConfiguration, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

###### 9CH0

Instance id: | SPB_DET_AGIPD1M-1/DET/9CH0
Class id: | DataAggregator
Host: | spb-br-sys-daq-9
Alias: | spb-br-sys-daq-9
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/pcLayer
Last modified: | 2021-07-02T01:27:47.000+02:00
Created at: | 2017-01-12T16:45:11.000+01:00
Main authors: | Boukhelef
Latest tag: | 1.10.3-2.10.5
Deployment tag: | 1.10.3-2.10.5
Projects: | AGIPD_DAQ, SPB_RUN_MANAGEMENT, CAMERAs, MAIN_copy
Scenes: | SPB_DAQ_STATUS, SPB_RUN_CONTROL_2-OBSOLETE, agipd_overview, SPB_DAQ_STATUS-OBSOLETE, CORRECTED_OVERVIEW, DAQ_RunControl_v2, MANAGER_NEW, DAQ_RunControl, agipd_overview, agipd_overview, FPGAConfiguration, agipd_overview, agipd_compact_monitoring_overview, AGIPD_corrected_preview, agipd_overview, AGIPD_controls, AGIPD_calibration_manager, agipd_overview_zoom
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether 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.10.3-2.10.5

Created: | 2021-06-28T07:58:03.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.3-2.10.5

1.10.3-2.10.5-rc2

Created: | 2021-06-25T06:12:26.000Z
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-23T23:21:52.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc1

1.10.3-2.10.5-rc0

Created: | 2021-06-20T23:03:13.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate 1.10.3-2.10.5-rc0

1.10.3-2.10.5-ra4

Created: | 2021-06-14T05:48:22.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra4

1.10.3-2.10.5-ra3

Created: | 2021-06-09T21:44:24.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.3-2.10.5-ra3

1.10.3-2.10.5-ra2

Created: | 2021-06-09T14:22:33.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.3-2.10.5-ra1

Created: | 2021-06-09T12:53:52.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.10.1-rx2

Created: | 2021-06-03T16:06:16.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.1-2.10.1-rx1

Created: | 2021-06-02T10:39:31.000Z
Author: | Nasser Al-Qudami
Notes: |

1.10.2-2.10.0-rx4

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Test tag 1.10.2-2.10.0-rx4

1.10.2-2.10.0

Created: | 2021-05-26T12:25:23.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.2-2.10.0

1.10.2-2.10.0-rx3

Created: | 2021-05-26T06:29:43.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx3

1.10.2-2.10.0-rx2

Created: | 2021-05-25T16:06:03.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx2

1.10.2-2.10.0-rx1

Created: | 2021-05-14T08:36:11.000Z
Author: | Djelloul Boukhelef
Notes: | Test release 1.10.2-2.10.0-rx1

1.10.1-2.11.0rc2

Created: | 2021-05-06T15:43:49.000Z
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-30T00:26:16.000Z
Author: | Djelloul Boukhelef
Notes: |

1.10.1-2.11.0rc1

Created: | 2021-04-29T08:32:19.000Z
Author: | Alessandro Silenzi
Notes: |

1.10.1-2.10.0-rc5

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release candidate of PC Layer 1.10.1-2.10.0-rc5

1.10.1-2.10.0

Created: | 2021-03-04T23:12:57.000Z
Author: | Djelloul Boukhelef
Notes: | Release of PC layer 1.10.1-2.10.0

#### AGIPD

[add component documentation]

##### SINGLE

[add component documentation]

###### CCMON

[add component documentation]

CUSTOM

Instance id: | SPB_DET_AGIPD_SINGLE/CCMON/CUSTOM
Class id: | Ccmon
Host: | spb-exp-sys-utc-1
Alias: | exflutc109-mch , exflutca109-mch , exflqr19805-mch
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/ccmon
Last modified: | 2021-06-23T17:35:49.000+02:00
Created at: | 2017-03-02T15:01:59.000+01:00
Main authors: | Parenti, Schaffer, Ehsan
Latest tag: | 1.2.5-2.11.1
Deployment tag: | 1.2.5-2.11.1
Installed tag: | 1.2.5-2.11.1
Scenes: | overview
Accessible by: | CONTROLS, CTRL, DET, babies, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- 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 true - C&C sync 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_latency:
    Number of clock cycles between receiving the trigger signal and generating FAST/VETO signals.
- 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:
    Defines the source of the VETO parameters.
- veto_num_vetos:
    Number of VETO decisions to read from memory (simulation/Bunch Pattern only).
- 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
- bunchPatternNode:
    Set up bunch pattern decoding parameters

Release History
1.2.5-2.11.1

Created: | 2021-06-23T15:24:40.000Z
Author: | Wajid Ehsan
Notes: | Don’t poll if bunch pattern decoding is not enabled

1.2.4-2.11.1

Created: | 2021-06-15T16:08:50.000Z
Author: | Wajid Ehsan
Notes: | Update Depends tag

1.2.3-2.11.1

Created: | 2021-06-14T13:05:33.000Z
Author: | Wajid Ehsan
Notes: | Add tag for uTCAConfigurations

1.2.2-2.11.1

Created: | 2021-06-09T09:35:28.000Z
Author: | Wajid Ehsan
Notes: | Use tag for iibus related devices

1.2.1-2.11.1

Created: | 2021-06-02T18:23:01.000Z
Author: | Andrea Parenti
Notes: | Feat/v37 + init fixes + Install pciedev_io.h on CI

1.2.0-2.10.0

Created: | 2020-11-23T17:14:00.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.7.1

Created: | 2020-02-18T10:32:07.000Z
Author: | Gabriele Giovanetti
Notes: |

1.2.0-2.7.1-select-backplane-trigger-01

Created: | 2020-02-10T10:43:05.000Z
Author: | Gabriele Giovanetti
Notes: |

1.1.0-2.7.0

Created: | 2020-01-13T14:58:57.000Z
Author: | Gabriele Giovanetti
Notes: | Parameters get timestamp and trainid from local hardware.

1.0.5-2.2.4

Created: | 2018-08-03T09:10:45.000Z
Author: | Alessandro Silenzi
Notes: | minor fix due to name change in C&C firmware project

1.0.4-2.2.3

Created: | 2018-06-14T08:00:10.000Z
Author: | Andrea Parenti
Notes: | Update register names for C&C 4.1.0

1.0.3-2.2.3

Created: | 2018-06-06T09:56:51.000Z
Author: | Andrea Parenti
Notes: | Two fixes to expected paramers

1.0.2-2.2.1

Created: | 2018-02-22T09:59:04.000Z
Author: | Andrea Parenti
Notes: | Fix Netbeans configuration and Makefile for Release mode

1.0.1-2.2.1

Created: | 2018-02-09T13:08:32.000Z
Author: | Andrea Parenti
Notes: | Add 2.1 and 2.2 to KARABO_CLASSINFO

1.0.1-2.1.0

Created: | 2018-01-17T15:33:25.000Z
Author: | esenov
Notes: |

1.0.0-2.1

Created: | 2017-05-15T08:19:36.000Z
Author: | Andrea Parenti
Notes: | AGIPD Squad version

#### AGIPD64K

[add component documentation]

##### CAL

[add component documentation]

###### APPEND_CORRECTED

Instance id: | SPB_DET_AGIPD64K/CAL/APPEND_CORRECTED
Class id: | CppFemCombiner
Host: | exflong03
Alias: | sa1-br-sys-cal-3 , spb-br-sys-cal-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/cppFemCombiner
Last modified: | 2020-11-20T16:46:45.000+01:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Ahmed, Michelat
Latest tag: | 1.4.3-2.9.1
Deployment tag: | 1.4.3-2.9.1
Scenes: | agipg64k_online_preview, overview, Images
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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
- output:
    Output channel for combined data
- filteredOutput:
    Output channel for combined data, filtered to a single image
- indexToFilter:
    single frame for index >= 0, max pixel value across cells: -1, mean value over cells: -2, sum over cells: -3 standard deviation over cells : -4
- bufferLength:
    Length of buffer to hold non-complete trains in

Release History
1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

0.2-2.2.3.5

Created: | 2018-05-22T07:47:19.000Z
Author: | Steffen Hauf
Notes: |

0.1-2.2.3.5

Created: | 2018-05-15T13:16:05.000Z
Author: | Steffen Hauf
Notes: |

###### APPEND_RAW

Instance id: | SPB_DET_AGIPD64K/CAL/APPEND_RAW
Class id: | CppFemCombiner
Host: | exflong03
Alias: | sa1-br-sys-cal-3 , spb-br-sys-cal-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/cppFemCombiner
Last modified: | 2020-11-20T16:46:45.000+01:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Ahmed, Michelat
Latest tag: | 1.4.3-2.9.1
Deployment tag: | 1.4.3-2.9.1
Scenes: | overview, Images
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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
- output:
    Output channel for combined data
- filteredOutput:
    Output channel for combined data, filtered to a single image
- indexToFilter:
    single frame for index >= 0, max pixel value across cells: -1, mean value over cells: -2, sum over cells: -3 standard deviation over cells : -4
- bufferLength:
    Length of buffer to hold non-complete trains in

Release History
1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

0.2-2.2.3.5

Created: | 2018-05-22T07:47:19.000Z
Author: | Steffen Hauf
Notes: |

0.1-2.2.3.5

Created: | 2018-05-15T13:16:05.000Z
Author: | Steffen Hauf
Notes: |

###### APPEND_RAW_GAIN

Instance id: | SPB_DET_AGIPD64K/CAL/APPEND_RAW_GAIN
Class id: | CppFemCombiner
Host: | exflong03
Alias: | sa1-br-sys-cal-3 , spb-br-sys-cal-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/cppFemCombiner
Last modified: | 2020-11-20T16:46:45.000+01:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Ahmed, Michelat
Latest tag: | 1.4.3-2.9.1
Deployment tag: | 1.4.3-2.9.1
Scenes: | overview, Images
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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
- output:
    Output channel for combined data
- filteredOutput:
    Output channel for combined data, filtered to a single image
- indexToFilter:
    single frame for index >= 0, max pixel value across cells: -1, mean value over cells: -2, sum over cells: -3 standard deviation over cells : -4
- bufferLength:
    Length of buffer to hold non-complete trains in

Release History
1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

0.2-2.2.3.5

Created: | 2018-05-22T07:47:19.000Z
Author: | Steffen Hauf
Notes: |

0.1-2.2.3.5

Created: | 2018-05-15T13:16:05.000Z
Author: | Steffen Hauf
Notes: |

###### CAL_MANAGER

Instance id: | SPB_DET_AGIPD64K/CAL/CAL_MANAGER
Class id: | CalManager
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-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: | agipg64k_online_preview, overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings

Release History
1.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: |

###### COMBINE_CORRECTED

Instance id: | SPB_DET_AGIPD64K/CAL/COMBINE_CORRECTED
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-20T22:17:09.000+01:00
Created at: | 2017-03-10T08:22:26.000+01:00
Main authors: | Santos, Kamil, Samartsev
Latest tag: | 1.4.0-2.9.1
Deployment tag: | 1.4.0-2.9.1
Scenes: | agipg64k_online_preview, overview, Images
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- output:
    Output channel for combined data

Release History
1.4.0-2.9.1

Created: | 2020-07-23T13:57:30.000Z
Author: | Hugo Santos
Notes: |

1.3.1-2.7.0

Created: | 2020-01-28T09:49:16.000Z
Author: | scsonc
Notes: | 28.01.2020

1.3.0-2.4.1

Created: | 2019-05-02T08:14:16.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.3.4

Created: | 2019-02-08T12:54:06.000Z
Author: | Steffen Hauf
Notes: |

1.1.1-2.2.4

Created: | 2018-07-20T11:55:37.000Z
Author: | Andrea Parenti
Notes: | FIX ImageData encoding

1.1.0-2.2.3.5

Created: | 2018-05-17T06:20:59.000Z
Author: | Steffen Hauf
Notes: |

1.0.15-2.2.0

Created: | 2018-05-09T06:31:55.000Z
Author: | Steffen Hauf
Notes: |

1.0.14-2.2.0

Created: | 2018-03-27T07:31:11.000Z
Author: | Thomas Michelat
Notes: |

1.0.13-2.2.0

Created: | 2018-02-28T15:23:55.000Z
Author: | Dennis Goeries
Notes: |

1.0.12-2.2.0

Created: | 2018-02-23T09:45:16.000Z
Author: | Steffen Hauf
Notes: |

1.0.11-2.2.0

Created: | 2018-02-06T15:57:13.000Z
Author: | Steffen Hauf
Notes: |

1.0.10-2.2.0

Created: | 2018-01-15T09:43:49.000Z
Author: | Steffen Hauf
Notes: |

1.0.9-2.1.18

Created: | 2017-11-08T13:00:30.000Z
Author: | Thomas Michelat
Notes: |

1.0.8-2.1.18

Created: | 2017-11-08T09:40:13.000Z
Author: | Thomas Michelat
Notes: |

1.0.7-2.1.15

Created: | 2017-08-31T07:19:57.000Z
Author: | Thomas Michelat
Notes: |

1.0.6-2.1.12

Created: | 2017-08-21T07:13:12.000Z
Author: | Steffen Hauf
Notes: |

1.0.5-2.1.12

Created: | 2017-08-17T06:08:37.000Z
Author: | Steffen Hauf
Notes: |

1.0.4-2.1.12

Created: | 2017-08-11T10:51:58.000Z
Author: | Steffen Hauf
Notes: |

1.0.3-2.1.12

Created: | 2017-08-10T06:08:02.000Z
Author: | Steffen Hauf
Notes: |

1.0.2-2.1.12

Created: | 2017-08-09T12:32:58.000Z
Author: | Steffen Hauf
Notes: |

###### COMBINE_RAW

Instance id: | SPB_DET_AGIPD64K/CAL/COMBINE_RAW
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-20T22:17:09.000+01:00
Created at: | 2017-03-10T08:22:26.000+01:00
Main authors: | Santos, Kamil, Samartsev
Latest tag: | 1.4.0-2.9.1
Deployment tag: | 1.4.0-2.9.1
Scenes: | agipg64k_online_preview, overview, Images
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- output:
    Output channel for combined data

Release History
1.4.0-2.9.1

Created: | 2020-07-23T13:57:30.000Z
Author: | Hugo Santos
Notes: |

1.3.1-2.7.0

Created: | 2020-01-28T09:49:16.000Z
Author: | scsonc
Notes: | 28.01.2020

1.3.0-2.4.1

Created: | 2019-05-02T08:14:16.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.3.4

Created: | 2019-02-08T12:54:06.000Z
Author: | Steffen Hauf
Notes: |

1.1.1-2.2.4

Created: | 2018-07-20T11:55:37.000Z
Author: | Andrea Parenti
Notes: | FIX ImageData encoding

1.1.0-2.2.3.5

Created: | 2018-05-17T06:20:59.000Z
Author: | Steffen Hauf
Notes: |

1.0.15-2.2.0

Created: | 2018-05-09T06:31:55.000Z
Author: | Steffen Hauf
Notes: |

1.0.14-2.2.0

Created: | 2018-03-27T07:31:11.000Z
Author: | Thomas Michelat
Notes: |

1.0.13-2.2.0

Created: | 2018-02-28T15:23:55.000Z
Author: | Dennis Goeries
Notes: |

1.0.12-2.2.0

Created: | 2018-02-23T09:45:16.000Z
Author: | Steffen Hauf
Notes: |

1.0.11-2.2.0

Created: | 2018-02-06T15:57:13.000Z
Author: | Steffen Hauf
Notes: |

1.0.10-2.2.0

Created: | 2018-01-15T09:43:49.000Z
Author: | Steffen Hauf
Notes: |

1.0.9-2.1.18

Created: | 2017-11-08T13:00:30.000Z
Author: | Thomas Michelat
Notes: |

1.0.8-2.1.18

Created: | 2017-11-08T09:40:13.000Z
Author: | Thomas Michelat
Notes: |

1.0.7-2.1.15

Created: | 2017-08-31T07:19:57.000Z
Author: | Thomas Michelat
Notes: |

1.0.6-2.1.12

Created: | 2017-08-21T07:13:12.000Z
Author: | Steffen Hauf
Notes: |

1.0.5-2.1.12

Created: | 2017-08-17T06:08:37.000Z
Author: | Steffen Hauf
Notes: |

1.0.4-2.1.12

Created: | 2017-08-11T10:51:58.000Z
Author: | Steffen Hauf
Notes: |

1.0.3-2.1.12

Created: | 2017-08-10T06:08:02.000Z
Author: | Steffen Hauf
Notes: |

1.0.2-2.1.12

Created: | 2017-08-09T12:32:58.000Z
Author: | Steffen Hauf
Notes: |

###### COMBINE_RAW_GAIN

Instance id: | SPB_DET_AGIPD64K/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-20T22:17:09.000+01:00
Created at: | 2017-03-10T08:22:26.000+01:00
Main authors: | Santos, Kamil, Samartsev
Latest tag: | 1.4.0-2.9.1
Deployment tag: | 1.4.0-2.9.1
Scenes: | agipg64k_online_preview, overview, Images
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- output:
    Output channel for combined data

Release History
1.4.0-2.9.1

Created: | 2020-07-23T13:57:30.000Z
Author: | Hugo Santos
Notes: |

1.3.1-2.7.0

Created: | 2020-01-28T09:49:16.000Z
Author: | scsonc
Notes: | 28.01.2020

1.3.0-2.4.1

Created: | 2019-05-02T08:14:16.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.3.4

Created: | 2019-02-08T12:54:06.000Z
Author: | Steffen Hauf
Notes: |

1.1.1-2.2.4

Created: | 2018-07-20T11:55:37.000Z
Author: | Andrea Parenti
Notes: | FIX ImageData encoding

1.1.0-2.2.3.5

Created: | 2018-05-17T06:20:59.000Z
Author: | Steffen Hauf
Notes: |

1.0.15-2.2.0

Created: | 2018-05-09T06:31:55.000Z
Author: | Steffen Hauf
Notes: |

1.0.14-2.2.0

Created: | 2018-03-27T07:31:11.000Z
Author: | Thomas Michelat
Notes: |

1.0.13-2.2.0

Created: | 2018-02-28T15:23:55.000Z
Author: | Dennis Goeries
Notes: |

1.0.12-2.2.0

Created: | 2018-02-23T09:45:16.000Z
Author: | Steffen Hauf
Notes: |

1.0.11-2.2.0

Created: | 2018-02-06T15:57:13.000Z
Author: | Steffen Hauf
Notes: |

1.0.10-2.2.0

Created: | 2018-01-15T09:43:49.000Z
Author: | Steffen Hauf
Notes: |

1.0.9-2.1.18

Created: | 2017-11-08T13:00:30.000Z
Author: | Thomas Michelat
Notes: |

1.0.8-2.1.18

Created: | 2017-11-08T09:40:13.000Z
Author: | Thomas Michelat
Notes: |

1.0.7-2.1.15

Created: | 2017-08-31T07:19:57.000Z
Author: | Thomas Michelat
Notes: |

1.0.6-2.1.12

Created: | 2017-08-21T07:13:12.000Z
Author: | Steffen Hauf
Notes: |

1.0.5-2.1.12

Created: | 2017-08-17T06:08:37.000Z
Author: | Steffen Hauf
Notes: |

1.0.4-2.1.12

Created: | 2017-08-11T10:51:58.000Z
Author: | Steffen Hauf
Notes: |

1.0.3-2.1.12

Created: | 2017-08-10T06:08:02.000Z
Author: | Steffen Hauf
Notes: |

1.0.2-2.1.12

Created: | 2017-08-09T12:32:58.000Z
Author: | Steffen Hauf
Notes: |

###### CORR_BPMASK

Instance id: | SPB_DET_AGIPD64K/CAL/CORR_BPMASK
Class id: | MaskBadPixels
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-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: | agipg64k_online_preview, overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- calibration_hash_schema_version:
    Version of the Hash Schema Definition
- device_name:
    Should be of form INSTANCE.MODULE
- caldb_zmq_timeout:
    Timeout for ZMQ request
- propertyUpdateInterval:
    Set time inteval between property updates
- eosCallback:
    Optionally call this function on an EOS event.
- isEntryPoint:
    Device is entry point to a pipeline. Stalls will occur here if iteration happens
- active:
    If set to False data is simply passed on
- dontProcess:
    Perform all housekeeping on GPU etc. but don’t run any algorithms on data

Release History
1.17.0-2.9.1

Created: | 2020-10-21T14:26:49.000Z
Author: | Karim Ahmed
Notes: | # Exposed disable_low_gain in the schema for Thresholding calibration.

1.16.2-2.9.1

Created: | 2020-10-05T10:27:41.000Z
Author: | Ebad Kamil
Notes: | UPDATE DEPENDS

1.16.1-2.9.1

Created: | 2020-09-28T17:39:02.000Z
Author: | Karim Ahmed
Notes: |

1.16.0-2.9.1

Created: | 2020-09-22T15:07:34.000Z
Author: | Karim Ahmed
Notes: |

1.15.3-2.9.1

Created: | 2020-08-25T08:29:35.000Z
Author: | Thomas Michelat
Notes: |

1.15.2-2.9.1

Created: | 2020-07-08T11:47:18.000Z
Author: | Thomas Michelat
Notes: | FIX verify configuration

1.15.1-2.9.1

Created: | 2020-06-29T15:47:12.000Z
Author: | Karim Ahmed
Notes: |

1.15.0-2.7.1

Created: | 2020-06-05T12:55:03.000Z
Author: | Karim Ahmed
Notes: |

1.14.0-2.7.1

Created: | 2020-03-31T13:01:59.000Z
Author: | Thomas Kluyver
Notes: |

test_002

Created: | 2020-03-31T06:49:32.000Z
Author: | Mikhail Karnevskiy
Notes: |

test_001

Created: | 2020-03-27T10:39:06.000Z
Author: | karnem
Notes: |

1.13.0-2.7.0

Created: | 2020-02-26T11:05:41.000Z
Author: | Karim Ahmed
Notes: | DEPENDS Update: add new module ePix100_burn @HED

1.12.0-2.7.0

Created: | 2020-02-18T13:26:41.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

###### CORR_OFFSET

Instance id: | SPB_DET_AGIPD64K/CAL/CORR_OFFSET
Class id: | OffsetCorrectionAGIPD
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-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: | agipg64k_online_preview, overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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_THRESHOLDING

Instance id: | SPB_DET_AGIPD64K/CAL/CORR_THRESHOLDING
Class id: | ThresholdingAGIPD
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-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: | agipg64k_online_preview, overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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: |

###### FEM_SPLITTER_AGIPD64K

Instance id: | SPB_DET_AGIPD64K/CAL/FEM_SPLITTER_AGIPD64K
Class id: | CppFemSplitter
Host: | exflong03
Alias: | sa1-br-sys-cal-3 , spb-br-sys-cal-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/cppFemCombiner
Last modified: | 2020-11-20T16:46:45.000+01:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Ahmed, Michelat
Latest tag: | 1.4.3-2.9.1
Deployment tag: | 1.4.3-2.9.1
Scenes: | agipg64k_online_preview, overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- input:
    Input channel for data from dispatchers
- fastSources:
    Sources as provided in channel meta data that contain fast data. Provide in the form source:path.in.hash to identify both source and path in the source data hash.
- generateTestData:
    Generate test data based on last input real data
- gpuFreeLimit:
    Temporarily stall the pipeline, and free GPU resources if below this limit

Release History
1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

0.2-2.2.3.5

Created: | 2018-05-22T07:47:19.000Z
Author: | Steffen Hauf
Notes: |

0.1-2.2.3.5

Created: | 2018-05-15T13:16:05.000Z
Author: | Steffen Hauf
Notes: |

###### RESTART

Instance id: | SPB_DET_AGIPD64K/CAL/RESTART
Class id: | RestartCalServers
Host: | exflong03
Alias: | sa1-br-sys-cal-3 , spb-br-sys-cal-3
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calML
Last modified: | 2020-11-18T14:36:02.000+01:00
Created at: | 2018-09-04T11:04:09.000+02:00
Main authors: | Danilevski, Samartsev, Kamil
Latest tag: | 2.2.0-2.9.1
Deployment tag: | 2.2.0-2.9.1
Scenes: | overview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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
- serverId:
    The device-server which this device is running on
- hostName:
    The name of the host where this device runs
- 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
- execute:
    Perform a server restart.

Release History
2.2.0-2.9.1

Created: | 2020-10-21T14:21:10.000Z
Author: | Karim Ahmed
Notes: |

2.1.2-2.9.1-fixSplitterFilter

Created: | 2020-09-28T17:32:59.000Z
Author: | Thomas Michelat
Notes: |

2.1.2-2.9.1

Created: | 2020-08-14T12:55:05.000Z
Author: | Thomas Michelat
Notes: | Update default configuration for DSSC

2.1.1-2.9.1

Created: | 2020-07-08T11:46:27.000Z
Author: | Thomas Michelat
Notes: | FIX verify config

2.1-2.7.1

Created: | 2020-04-06T13:46:47.000Z
Author: | Mikhail Karnevskiy
Notes: |

2.0-2.7.1

Created: | 2020-01-31T09:55:39.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.9-2.5.1

Created: | 2019-08-27T11:44:22.000Z
Author: | Steffen Hauf
Notes: |

1.8-2.5.1

Created: | 2019-07-30T13:46:44.000Z
Author: | Steffen Hauf
Notes: |

1.7-2.5.1

Created: | 2019-07-30T13:24:49.000Z
Author: | Steffen Hauf
Notes: |

1.6-2.4.1

Created: | 2019-07-12T08:40:29.000Z
Author: | Steffen Hauf
Notes: |

1.5-2.4.1

Created: | 2019-07-02T09:10:31.000Z
Author: | Steffen Hauf
Notes: |

1.4-2.4.1

Created: | 2019-05-16T10:01:01.000Z
Author: | Steffen Hauf
Notes: |

1.3-2.4.1

Created: | 2019-05-09T17:22:28.000Z
Author: | Steffen Hauf
Notes: |

1.2-2.4.1

Created: | 2019-05-02T08:45:04.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.3.4

Created: | 2019-02-08T12:58:06.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.1

Created: | 2019-02-01T13:54:24.000Z
Author: | Steffen Hauf
Notes: |

#### AGIPD64KTEST

[add component documentation]

##### CCML

[add component documentation]

###### VETO

Instance id: | SPB_DET_AGIPD64KTEST/CCML/VETO
Class id: | ClockAndControlML
Host: | spb-exp-sys-utc-1
Alias: | exflutc109-mch , exflutca109-mch , exflqr19805-mch
Git repo: | https://git.xfel.eu/gitlab/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
Accessible by: | CONTROLS, CTRL, DET, babies, 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
- 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-06T11:23:24.000Z
Author: | Cyril Danilevski
Notes: |

1.2.0-2.10.0

Created: | 2020-11-23T17:16:33.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.2.4

Created: | 2018-06-27T12:36:03.000Z
Author: | Gabriele Giovanetti
Notes: | Set DAQ policies

1.1.1-2.2.1

Created: | 2018-01-29T14:47:28.000Z
Author: | Cyril Danilevski
Notes: |

1.1.0-2.2.0

Created: | 2017-12-20T16:25:03.000Z
Author: | Cyril Danilevski
Notes: |

1.1.0-2.1.18

Created: | 2017-12-20T16:25:03.000Z
Author: | Cyril Danilevski
Notes: |

1.0.1-2.1.12

Created: | 2017-08-17T08:42:30.000Z
Author: | Cyril Danilevski
Notes: | Fixes the indexing of bunches

1.0.0-2.1.12

Created: | 2017-07-24T09:26:55.000Z
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)

##### ZEROMQ

[add component documentation]

###### CORR

Instance id: | SPB_DET_AGIPD64KTEST/ZEROMQ/CORR
Class id: | PipeToZeroMQ
Host: | exflonc01
Alias: | sa1-br-kc-comp-1 , la1-br-kc-comp-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-07-17T18:18:44.000+02:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Michelat, Tmichela
Latest tag: | 3.1.1-2.9.0
Deployment tag: | 3.1.1-2.9.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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: |

#### COMBI

[add component documentation]

##### BRIDGE

[add component documentation]

###### AGIPD_JNGFR

Instance id: | SPB_DET_COMBI/BRIDGE/AGIPD_JNGFR
Class id: | PipeToZeroMQ
Host: | exflonc01
Alias: | la1-br-kc-comp-1 , sa1-br-kc-comp-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-11-20T21:40:07.000+01:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Dall’antonia, Michelat, Silenzi
Latest tag: | 3.2.4-2.10.0
Deployment tag: | 3.2.4-2.10.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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: |

##### MATCH

[add component documentation]

###### AGIPD_JNGFR

Instance id: | SPB_DET_COMBI/MATCH/AGIPD_JNGFR
Class id: | TrainMatcher
Host: | exflonc01
Alias: | la1-br-kc-comp-1 , sa1-br-kc-comp-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/TrainMatcher
Last modified: | 2020-11-20T21:03:19.000+01:00
Created at: | 2018-04-25T15:34:20.000+02:00
Main authors: | Michelat, Tmichela
Latest tag: | 1.0.0-2.7.1
Deployment tag: | 1.0.0-2.7.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- channels:
    list output channel to monitor.
- fastSources:
    Data sources names and configuration from connected output channels
- slowSources:
    Device properties to monitor
- output:
    Output channel for combined train data.
- sent:
    Count how many train data were sent.
- trainId:
    the last trainId data that matched.
- buffer:
    Length of buffer to hold non-complete trains in.

Release History
1.0.0-2.7.1

Created: | 2020-02-18T13:21:57.000Z
Author: | Thomas Michelat
Notes: | Re-implementation: add default scene reconfigurable at run-time: add/remove pipeline connections, add remove fast and slow data) more accurate matching for slow properties train offset for pipeline data show processing info

0.2.1-2.5.0

Created: | 2019-08-27T07:48:16.000Z
Author: | Thomas Michelat
Notes: | add property to allow sending data if input source is missing. add simple implementation of slow data monitor bugfix: handle properly multiple output channel from same device

1.0.0b2-2.4.1

Created: | 2019-05-13T14:44:05.000Z
Author: | Thomas Michelat
Notes: |

0.2.0b1-2.4.0

Created: | 2019-05-03T13:40:27.000Z
Author: | Thomas Michelat
Notes: | simple slow data monitoring, bulked property updates

1.0.0b1-2.4.0

Created: | 2019-03-18T18:50:21.000Z
Author: | Ebad Kamil
Notes: | first “real” try of monitoring slow data (will change)

0.1.0-2.4.0

Created: | 2018-04-27T12:01:19.000Z
Author: | Thomas Michelat
Notes: |

### EHC

[add component documentation]

#### VAC

[add component documentation]

##### VALVE

[add component documentation]

###### VALVE_ROUGH_3

Instance id: | SPB_EHC_VAC/VALVE/VALVE_ROUGH_3
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | Rough-Vacuum, Instrument-Overview-Long, Instrument-Overview-Long-NoCRL, SAXS-Instrument-Overview-NotUTD, Instrument-Overview-Long, Instrument-Overview-Long, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, Overview, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_INLINE_1

Instance id: | SPB_EHC_VAC/VALVE/VALVE_INLINE_1
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | Instrument-Overview-Long, Instrument-Overview-Long, Instrument-Overview-Long, Instrument-Overview-Long-IRDa, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_INLINE_2

Instance id: | SPB_EHC_VAC/VALVE/VALVE_INLINE_2
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | Instrument-Overview-Long, Instrument-Overview-Long, Instrument-Overview-Long, Instrument-Overview-Long-IRDa, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_INLINE_3

Instance id: | SPB_EHC_VAC/VALVE/VALVE_INLINE_3
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | Overview, Overview, Overview, Overview, Overview, SPB-Mode-1-overview-RB, SPB Mode 1 overview, MPS_INTERLOCK
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_INLINE_4

Instance id: | SPB_EHC_VAC/VALVE/VALVE_INLINE_4
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | Overview
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_ROUGH_1

Instance id: | SPB_EHC_VAC/VALVE/VALVE_ROUGH_1
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | Rough-Vacuum, Instrument-Overview-Long, agipd_overview, vacuum_tests, vacuum_tests_11.04, Instrument-Overview-Long-NoCRL, SAXS-Instrument-Overview-NotUTD, agipd_overview, Instrument-Overview-Long, Instrument-Overview-Long, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, agipd_overview, Overview, agipd_overview, agipd_compact_monitoring_overview, Instrument-Overview-Long_CW39-42, agipd_overview, AGIPD_controls, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_ROUGH_2

Instance id: | SPB_EHC_VAC/VALVE/VALVE_ROUGH_2
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | Rough-Vacuum, Instrument-Overview-Long, Instrument-Overview-Long-NoCRL, SAXS-Instrument-Overview-NotUTD, Instrument-Overview-Long, Instrument-Overview-Long, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, Overview, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

##### ACTRL

[add component documentation]

###### AI_2

Instance id: | SPB_EHC_VAC/ACTRL/AI_2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### AI_1

Instance id: | SPB_EHC_VAC/ACTRL/AI_1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

##### DCTRL

[add component documentation]

###### PUMP_TURBO_1_RPM80

Instance id: | SPB_EHC_VAC/DCTRL/PUMP_TURBO_1_RPM80
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-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

###### DI_1

Instance id: | SPB_EHC_VAC/DCTRL/DI_1
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T09:55:43.000Z
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

###### DI_2

Instance id: | SPB_EHC_VAC/DCTRL/DI_2
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T09:55:43.000Z
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

###### GAUGE_FR_1_Value

Instance id: | SPB_EHC_VAC/DCTRL/GAUGE_FR_1_Value
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-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

###### VALVE_ROUGH_1_Open

Instance id: | SPB_EHC_VAC/DCTRL/VALVE_ROUGH_1_Open
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-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

##### GAUGE

[add component documentation]

###### GAUGE_PR_4

Instance id: | SPB_EHC_VAC/GAUGE/GAUGE_PR_4
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_1

Instance id: | SPB_EHC_VAC/GAUGE/GAUGE_FR_1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | VACUUM_FULL, Instrument-Overview-Long, Overview, Pressure-Plots, Overview, VACUUM_FULL2, SAXS-Instrument-Overview-NotUTD, Overview, Instrument-Overview-Long, Overview, Instrument-Overview-Long, Overview, SAXS Instrument Overview, Instrument-Overview-NotUTD, VACUUM_FULL2, Overview, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_2

Instance id: | SPB_EHC_VAC/GAUGE/GAUGE_FR_2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | VACUUM_FULL, Overview, Pressure-Plots, Overview, Instrument-Overview-Long-NoCRL, VACUUM_FULL2, Overview, Instrument-Overview-Long, Overview, Instrument-Overview-Long, Overview, Instrument-Overview-Long-IRDa, VACUUM_FULL2, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long-Imaging
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_3

Instance id: | SPB_EHC_VAC/GAUGE/GAUGE_FR_3
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | Instrument-Overview-Long, SAXS-Instrument-Overview-NotUTD, Instrument-Overview-Long, Instrument-Overview-Long, SAXS Instrument Overview, Instrument-Overview-NotUTD, Overview, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_4

Instance id: | SPB_EHC_VAC/GAUGE/GAUGE_FR_4
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | Instrument-Overview-Long, Pressure-Plots, Instrument-Overview-Long-NoCRL, SAXS-Instrument-Overview-NotUTD, Instrument-Overview-Long, Instrument-Overview-Long, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, VACUUM_FULL2, Overview, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_5

Instance id: | SPB_EHC_VAC/GAUGE/GAUGE_FR_5
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_PR_1

Instance id: | SPB_EHC_VAC/GAUGE/GAUGE_PR_1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | Rough-Vacuum, Instrument-Overview-Long, agipd_overview, vacuum_tests, vacuum_tests_11.04, Instrument-Overview-Long-NoCRL, SAXS-Instrument-Overview-NotUTD, agipd_overview, Instrument-Overview-Long, Instrument-Overview-Long, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, agipd_overview, Overview, agipd_overview, agipd_compact_monitoring_overview, Instrument-Overview-Long_CW39-42, agipd_overview, AGIPD_controls, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_PR_2

Instance id: | SPB_EHC_VAC/GAUGE/GAUGE_PR_2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_PR_3

Instance id: | SPB_EHC_VAC/GAUGE/GAUGE_PR_3
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

##### ICTRL

[add component documentation]

###### PUMP_CTRL_1

Instance id: | SPB_EHC_VAC/ICTRL/PUMP_CTRL_1
Class id: | BeckhoffAgilentIonPump
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-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.
- 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.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

##### IPUMP

[add component documentation]

###### PUMP_ION_2

Instance id: | SPB_EHC_VAC/IPUMP/PUMP_ION_2
Class id: | BeckhoffAgilentIonPump
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-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.
- 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.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

###### PUMP_ION_1

Instance id: | SPB_EHC_VAC/IPUMP/PUMP_ION_1
Class id: | BeckhoffAgilentIonPump
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-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.
- 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.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

##### SWITCH

[add component documentation]

###### VALVE_ROUGH_1_Open

Instance id: | SPB_EHC_VAC/SWITCH/VALVE_ROUGH_1_Open
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T09:55:43.000Z
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

###### GAUGE_FR_1_Value

Instance id: | SPB_EHC_VAC/SWITCH/GAUGE_FR_1_Value
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T09:55:43.000Z
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

###### PUMP_TURBO_1_RPM80

Instance id: | SPB_EHC_VAC/SWITCH/PUMP_TURBO_1_RPM80
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T09:55:43.000Z
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

##### TPUMP

[add component documentation]

###### PUMP_TURBO_6

Instance id: | SPB_EHC_VAC/TPUMP/PUMP_TURBO_6
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | Turbo-control-old, Instrument-Overview-Long, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging, Turbo-control, Turbo-control
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### PUMP_TURBO_1

Instance id: | SPB_EHC_VAC/TPUMP/PUMP_TURBO_1
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | Turbo-control-old, Instrument-Overview-Long, Overview, Overview, Instrument-Overview-Long-NoCRL, SAXS-Instrument-Overview-NotUTD, Overview, Instrument-Overview-Long, Overview, Instrument-Overview-Long, Overview, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, Overview, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Turbo-control, Turbo-control
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### PUMP_TURBO_2

Instance id: | SPB_EHC_VAC/TPUMP/PUMP_TURBO_2
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | Turbo-control-old, Instrument-Overview-Long, Overview, Overview, Instrument-Overview-Long-NoCRL, SAXS-Instrument-Overview-NotUTD, Overview, Instrument-Overview-Long, Overview, Instrument-Overview-Long, Overview, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, Overview, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging, Turbo-control, Turbo-control
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### PUMP_TURBO_3

Instance id: | SPB_EHC_VAC/TPUMP/PUMP_TURBO_3
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | Turbo-control-old, Instrument-Overview-Long, Instrument-Overview-Long-NoCRL, SAXS-Instrument-Overview-NotUTD, Instrument-Overview-Long, Instrument-Overview-Long, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, Overview, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging, Turbo-control, Turbo-control
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### PUMP_TURBO_4

Instance id: | SPB_EHC_VAC/TPUMP/PUMP_TURBO_4
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | Turbo-control-old, Instrument-Overview-Long, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging, Turbo-control, Turbo-control
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### PUMP_TURBO_5

Instance id: | SPB_EHC_VAC/TPUMP/PUMP_TURBO_5
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | Turbo-control-old, Instrument-Overview-Long, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Turbo-control, Turbo-control
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

#### ATT

[add component documentation]

##### TSENS

[add component documentation]

###### ARM4_TB

Instance id: | SPB_EHC_ATT/TSENS/ARM4_TB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### APERTURE_TA

Instance id: | SPB_EHC_ATT/TSENS/APERTURE_TA
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### APERTURE_TB

Instance id: | SPB_EHC_ATT/TSENS/APERTURE_TB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM1_TA

Instance id: | SPB_EHC_ATT/TSENS/ARM1_TA
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM1_TB

Instance id: | SPB_EHC_ATT/TSENS/ARM1_TB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM2_TA

Instance id: | SPB_EHC_ATT/TSENS/ARM2_TA
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM2_TB

Instance id: | SPB_EHC_ATT/TSENS/ARM2_TB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM3_TA

Instance id: | SPB_EHC_ATT/TSENS/ARM3_TA
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM3_TB

Instance id: | SPB_EHC_ATT/TSENS/ARM3_TB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM4_TA

Instance id: | SPB_EHC_ATT/TSENS/ARM4_TA
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

##### MOTOR

[add component documentation]

###### CHAMX

###### ARM1

###### ARM2

###### ARM3

###### ARM4

#### CRL

[add component documentation]

##### TSENS

[add component documentation]

###### LENS9_T2

Instance id: | SPB_EHC_CRL/TSENS/LENS9_T2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### LENS10_T1

Instance id: | SPB_EHC_CRL/TSENS/LENS10_T1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### LENS10_T2

Instance id: | SPB_EHC_CRL/TSENS/LENS10_T2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### LENS1_T1

Instance id: | SPB_EHC_CRL/TSENS/LENS1_T1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### LENS1_T2

Instance id: | SPB_EHC_CRL/TSENS/LENS1_T2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### LENS2_T1

Instance id: | SPB_EHC_CRL/TSENS/LENS2_T1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### LENS2_T2

Instance id: | SPB_EHC_CRL/TSENS/LENS2_T2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### LENS3_T1

Instance id: | SPB_EHC_CRL/TSENS/LENS3_T1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### LENS3_T2

Instance id: | SPB_EHC_CRL/TSENS/LENS3_T2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### LENS4_T1

Instance id: | SPB_EHC_CRL/TSENS/LENS4_T1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### LENS4_T2

Instance id: | SPB_EHC_CRL/TSENS/LENS4_T2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### LENS5_T1

Instance id: | SPB_EHC_CRL/TSENS/LENS5_T1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### LENS5_T2

Instance id: | SPB_EHC_CRL/TSENS/LENS5_T2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### LENS6_T1

Instance id: | SPB_EHC_CRL/TSENS/LENS6_T1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### LENS6_T2

Instance id: | SPB_EHC_CRL/TSENS/LENS6_T2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### LENS7_T1

Instance id: | SPB_EHC_CRL/TSENS/LENS7_T1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### LENS7_T2

Instance id: | SPB_EHC_CRL/TSENS/LENS7_T2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### LENS8_T1

Instance id: | SPB_EHC_CRL/TSENS/LENS8_T1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### LENS8_T2

Instance id: | SPB_EHC_CRL/TSENS/LENS8_T2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### LENS9_T1

Instance id: | SPB_EHC_CRL/TSENS/LENS9_T1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

##### MOTOR

[add component documentation]

###### LENS9_Y

###### 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

##### MDL

[add component documentation]

###### LENS10_Y_BIU

Instance id: | SPB_EHC_CRL/MDL/LENS10_Y_BIU
Class id: | BeamImagingUnit
Host: | spb-rr-sys-con-16
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2021-05-21T17:41:00.000+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Costa, Goeries
Latest tag: | 1.3.7-2.11.0
Deployment tag: | 1.3.7-2.11.0
Installed tag: | 1.3.7-2.11.0
Scenes: | EHC_CRL_Lenses_Simple
Accessible by: | 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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveArm_10_in:
    Moves the motor to the position marked with this label
- moveArm_10_out:
    Moves the motor to the position marked with this label

Release History
1.3.7-2.11.0

Created: | 2021-05-20T15:44:30.000Z
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T13:56:25.000Z
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T14:53:29.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

###### LENS1_Y_BIU

Instance id: | SPB_EHC_CRL/MDL/LENS1_Y_BIU
Class id: | BeamImagingUnit
Host: | spb-rr-sys-con-16
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2021-05-21T17:41:00.000+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Costa, Goeries
Latest tag: | 1.3.7-2.11.0
Deployment tag: | 1.3.7-2.11.0
Installed tag: | 1.3.7-2.11.0
Scenes: | EHC_CRL_Lenses_Simple
Accessible by: | 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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveArm_1_in:
    Moves the motor to the position marked with this label
- moveArm_1_out:
    Moves the motor to the position marked with this label

Release History
1.3.7-2.11.0

Created: | 2021-05-20T15:44:30.000Z
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T13:56:25.000Z
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T14:53:29.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

###### LENS2_Y_BIU

Instance id: | SPB_EHC_CRL/MDL/LENS2_Y_BIU
Class id: | BeamImagingUnit
Host: | spb-rr-sys-con-16
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2021-05-21T17:41:00.000+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Costa, Goeries
Latest tag: | 1.3.7-2.11.0
Deployment tag: | 1.3.7-2.11.0
Installed tag: | 1.3.7-2.11.0
Scenes: | EHC_CRL_Lenses_Simple
Accessible by: | 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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveArm_2_in:
    Moves the motor to the position marked with this label
- moveArm_2_out:
    Moves the motor to the position marked with this label

Release History
1.3.7-2.11.0

Created: | 2021-05-20T15:44:30.000Z
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T13:56:25.000Z
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T14:53:29.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

###### LENS3_Y_BIU

Instance id: | SPB_EHC_CRL/MDL/LENS3_Y_BIU
Class id: | BeamImagingUnit
Host: | spb-rr-sys-con-16
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2021-05-21T17:41:00.000+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Costa, Goeries
Latest tag: | 1.3.7-2.11.0
Deployment tag: | 1.3.7-2.11.0
Installed tag: | 1.3.7-2.11.0
Scenes: | EHC_CRL_Lenses_Simple
Accessible by: | 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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveArm_3_in:
    Moves the motor to the position marked with this label
- moveArm_3_out:
    Moves the motor to the position marked with this label

Release History
1.3.7-2.11.0

Created: | 2021-05-20T15:44:30.000Z
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T13:56:25.000Z
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T14:53:29.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

###### LENS4_Y_BIU

Instance id: | SPB_EHC_CRL/MDL/LENS4_Y_BIU
Class id: | BeamImagingUnit
Host: | spb-rr-sys-con-16
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2021-05-21T17:41:00.000+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Costa, Goeries
Latest tag: | 1.3.7-2.11.0
Deployment tag: | 1.3.7-2.11.0
Installed tag: | 1.3.7-2.11.0
Scenes: | EHC_CRL_Lenses_Simple
Accessible by: | 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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveArm_4_in:
    Moves the motor to the position marked with this label
- moveArm_4_out:
    Moves the motor to the position marked with this label

Release History
1.3.7-2.11.0

Created: | 2021-05-20T15:44:30.000Z
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T13:56:25.000Z
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T14:53:29.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

###### LENS5_Y_BIU

Instance id: | SPB_EHC_CRL/MDL/LENS5_Y_BIU
Class id: | BeamImagingUnit
Host: | spb-rr-sys-con-16
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2021-05-21T17:41:00.000+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Costa, Goeries
Latest tag: | 1.3.7-2.11.0
Deployment tag: | 1.3.7-2.11.0
Installed tag: | 1.3.7-2.11.0
Scenes: | EHC_CRL_Lenses_Simple
Accessible by: | 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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveArm_5_in:
    Moves the motor to the position marked with this label
- moveArm_5_out:
    Moves the motor to the position marked with this label

Release History
1.3.7-2.11.0

Created: | 2021-05-20T15:44:30.000Z
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T13:56:25.000Z
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T14:53:29.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

###### LENS6_Y_BIU

Instance id: | SPB_EHC_CRL/MDL/LENS6_Y_BIU
Class id: | BeamImagingUnit
Host: | spb-rr-sys-con-16
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2021-05-21T17:41:00.000+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Costa, Goeries
Latest tag: | 1.3.7-2.11.0
Deployment tag: | 1.3.7-2.11.0
Installed tag: | 1.3.7-2.11.0
Scenes: | EHC_CRL_Lenses_Simple
Accessible by: | 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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveArm_6_in:
    Moves the motor to the position marked with this label
- moveArm_6_out:
    Moves the motor to the position marked with this label

Release History
1.3.7-2.11.0

Created: | 2021-05-20T15:44:30.000Z
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T13:56:25.000Z
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T14:53:29.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

###### LENS7_Y_BIU

Instance id: | SPB_EHC_CRL/MDL/LENS7_Y_BIU
Class id: | BeamImagingUnit
Host: | spb-rr-sys-con-16
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2021-05-21T17:41:00.000+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Costa, Goeries
Latest tag: | 1.3.7-2.11.0
Deployment tag: | 1.3.7-2.11.0
Installed tag: | 1.3.7-2.11.0
Scenes: | EHC_CRL_Lenses_Simple
Accessible by: | 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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveArm_7_in:
    Moves the motor to the position marked with this label
- moveArm_7_out:
    Moves the motor to the position marked with this label

Release History
1.3.7-2.11.0

Created: | 2021-05-20T15:44:30.000Z
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T13:56:25.000Z
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T14:53:29.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

###### LENS8_Y_BIU

Instance id: | SPB_EHC_CRL/MDL/LENS8_Y_BIU
Class id: | BeamImagingUnit
Host: | spb-rr-sys-con-16
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2021-05-21T17:41:00.000+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Costa, Goeries
Latest tag: | 1.3.7-2.11.0
Deployment tag: | 1.3.7-2.11.0
Installed tag: | 1.3.7-2.11.0
Scenes: | EHC_CRL_Lenses_Simple
Accessible by: | 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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveArm_8_in:
    Moves the motor to the position marked with this label
- moveArm_8_out:
    Moves the motor to the position marked with this label

Release History
1.3.7-2.11.0

Created: | 2021-05-20T15:44:30.000Z
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T13:56:25.000Z
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T14:53:29.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

###### LENS9_Y_BIU

Instance id: | SPB_EHC_CRL/MDL/LENS9_Y_BIU
Class id: | BeamImagingUnit
Host: | spb-rr-sys-con-16
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2021-05-21T17:41:00.000+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Costa, Goeries
Latest tag: | 1.3.7-2.11.0
Deployment tag: | 1.3.7-2.11.0
Installed tag: | 1.3.7-2.11.0
Scenes: | EHC_CRL_Lenses_Simple
Accessible by: | 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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveArm_9_in:
    Moves the motor to the position marked with this label
- moveArm_9_out:
    Moves the motor to the position marked with this label

Release History
1.3.7-2.11.0

Created: | 2021-05-20T15:44:30.000Z
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T13:56:25.000Z
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T14:53:29.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

#### CSS

[add component documentation]

##### SWITCH

[add component documentation]

###### OT_YPLUS

Instance id: | SPB_EHC_CSS/SWITCH/OT_YPLUS
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | CSS, CSS, CSS, CSS_CoordMotion
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T09:55:43.000Z
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

###### OT_XMINUS

Instance id: | SPB_EHC_CSS/SWITCH/OT_XMINUS
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | CSS, CSS, CSS, CSS_CoordMotion
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T09:55:43.000Z
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

###### OT_XPLUS

Instance id: | SPB_EHC_CSS/SWITCH/OT_XPLUS
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | CSS, CSS, CSS, CSS_CoordMotion
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T09:55:43.000Z
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

###### OT_YMINUS

Instance id: | SPB_EHC_CSS/SWITCH/OT_YMINUS
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | CSS, CSS, CSS, CSS_CoordMotion
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T09:55:43.000Z
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

##### MOTOR

[add component documentation]

###### YCRL

###### X1

###### X2

###### XCRL

###### Y1

###### Y2

##### MDL

[add component documentation]

###### MOTION

#### DPA1

[add component documentation]

##### MOTOR

[add component documentation]

###### HOLSTER_X

Instance id: | SPB_EHC_DPA1/MOTOR/HOLSTER_X
Host: | exflcon44n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[add instance documentation]

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.

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: |

###### CHAMBER_AX

Instance id: | SPB_EHC_DPA1/MOTOR/CHAMBER_AX
Host: | exflcon44n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[add instance documentation]

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.

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: |

###### CHAMBER_AY

Instance id: | SPB_EHC_DPA1/MOTOR/CHAMBER_AY
Host: | exflcon44n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[add instance documentation]

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.

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: |

###### CHAMBER_X

Instance id: | SPB_EHC_DPA1/MOTOR/CHAMBER_X
Host: | exflcon44n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[add instance documentation]

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.

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: |

###### CHAMBER_Y

Instance id: | SPB_EHC_DPA1/MOTOR/CHAMBER_Y
Host: | exflcon44n0
Class documentation:
| BeckhoffSimpleMotor
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[add instance documentation]

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.

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: |

##### DCTRL

[add component documentation]

###### LED

Instance id: | SPB_EHC_DPA1/DCTRL/LED
Host: | exflcon44n0
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### CAM

Instance id: | SPB_EHC_DPA1/DCTRL/CAM
Host: | exflcon44n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T13:04:48.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

##### ENC

[add component documentation]

###### HOLSTER_X

Instance id: | SPB_EHC_DPA1/ENC/HOLSTER_X
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### CHAMBER_AX

Instance id: | SPB_EHC_DPA1/ENC/CHAMBER_AX
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### CHAMBER_AY

Instance id: | SPB_EHC_DPA1/ENC/CHAMBER_AY
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### CHAMBER_X

Instance id: | SPB_EHC_DPA1/ENC/CHAMBER_X
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### CHAMBER_Y

Instance id: | SPB_EHC_DPA1/ENC/CHAMBER_Y
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

#### PAM

[add component documentation]

##### SAMPLE1

[add component documentation]

###### Y

[add component documentation]

MDL

[add component documentation]

BIU

Instance id: | SPB_EHC_PAM_SAMPLE1_Y/MDL/BIU
Host: | exflcon42n0
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2019-10-30T16:09:06.000+01:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Degon, Giovanetti, Mohacsi
Latest tag: | 1.3.5-2.4.0
Deployment tag: | 1.3.5-2.4.0
Installed tag: | 1.3.5-2.4.0
Scenes: | SPB_EHC_PAM_sample, SPB_EHC_PAM_sample, SPB_EHC_PAM_sample, SPB_EHC_PAM_sample, EHC_PAM_main, EHC_PAM_sample
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

[add instance documentation]

Release History
1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

##### CAL

[add component documentation]

###### SPEC_SIG

Instance id: | SPB_EHC_PAM/CAL/SPEC_SIG
Class id: | SlsCalibrator
Host: | spb-rr-sys-con-15
Alias: | spb-rr-sys-con-15
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: | EHC_PAM_GOTTHARD_SIG, SPB_EHC_PAM_GOTTHARD_SIG, SPB_EHC_PAM_GOTTHARD_SIG, SPB_EHC_PAM_GOTTHARD_SIG
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: |

###### SPEC_REF

Instance id: | SPB_EHC_PAM/CAL/SPEC_REF
Class id: | SlsCalibrator
Host: | spb-rr-sys-con-14
Alias: | spb-rr-sys-con-14
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: | EHC_PAM_GOTTHARD_REF, SPB_EHC_PAM_GOTTHARD_REF, SPB_EHC_PAM_GOTTHARD_REF, SPB_EHC_PAM_GOTTHARD_REF
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

[add component documentation]

###### SAMPLE_CAM

Instance id: | SPB_EHC_PAM/CAM/SAMPLE_CAM
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | SPB_EHC_PAM_state, EHC_PAM_state, SPB_EHC_PAM_CAM_SAMPLE, EHC_PAM_CAM_SAMPLE
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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

##### DAQ

[add component documentation]

###### SPEC_SIG

Instance id: | SPB_EHC_PAM/DAQ/SPEC_SIG
Class id: | GotthardReceiver
Host: | spb-rr-sys-con-15
Class documentation:
| GotthardReceiver
Alias: | spb-rr-sys-con-15
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: | EHC_PAM_GOTTHARDs_overview, EHC_PAM_SIG_spectrumMonitor, EHC_PAM_GOTTHARD_SIG, SPB_EHC_PAM_SIG_spectrumMonitor, SPB_EHC_PAM_GOTTHARD_SIG, SPB_EHC_PAM_GOTTHARD_SIG, SPB_EHC_PAM_GOTTHARD_SIG, EHC_PAM_SIG_spectrumMonitor0
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

###### SPEC_REF

Instance id: | SPB_EHC_PAM/DAQ/SPEC_REF
Class id: | GotthardReceiver
Host: | spb-rr-sys-con-14
Class documentation:
| GotthardReceiver
Alias: | spb-rr-sys-con-14
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: | EHC_PAM_GOTTHARDs_overview, EHC_PAM_GOTTHARD_REF, EHC_PAM_REF_spectrumMonitor, SPB_EHC_PAM_GOTTHARD_REF, SPB_EHC_PAM_REF_spectrumMonitor, SPB_EHC_PAM_GOTTHARD_REF, SPB_EHC_PAM_GOTTHARD_REF, EHC_PAM_REF_spectrumMonitor0
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

##### DET

[add component documentation]

###### SPEC_SIG

Instance id: | SPB_EHC_PAM/DET/SPEC_SIG
Class id: | GotthardControl
Host: | spb-rr-sys-con-15
Class documentation:
| GotthardControl
Alias: | spb-rr-sys-con-15
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: | EHC_PAM_GOTTHARDs_overview, EHC_PAM_SIG_spectrumMonitor, EHC_PAM_GOTTHARD_SIG, SPB_EHC_PAM_SIG_spectrumMonitor, SPB_EHC_PAM_GOTTHARD_SIG, SPB_EHC_PAM_GOTTHARD_SIG, SPB_EHC_PAM_GOTTHARD_SIG, EHC_PAM_SIG_spectrumMonitor0
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

###### SPEC_REF

Instance id: | SPB_EHC_PAM/DET/SPEC_REF
Class id: | GotthardControl
Host: | spb-rr-sys-con-14
Class documentation:
| GotthardControl
Alias: | spb-rr-sys-con-14
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: | EHC_PAM_GOTTHARDs_overview, EHC_PAM_GOTTHARD_REF, EHC_PAM_REF_spectrumMonitor, SPB_EHC_PAM_GOTTHARD_REF, SPB_EHC_PAM_REF_spectrumMonitor, SPB_EHC_PAM_GOTTHARD_REF, SPB_EHC_PAM_GOTTHARD_REF, EHC_PAM_REF_spectrumMonitor0
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

##### MDL

[add component documentation]

###### OPT_DLY

###### M2TX_BIU

Instance id: | SPB_EHC_PAM/MDL/M2TX_BIU
Class id: | BeamImagingUnit
Host: | spb-rr-sys-con-16
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2021-05-21T17:41:00.000+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Costa, Goeries
Latest tag: | 1.3.7-2.11.0
Deployment tag: | 1.3.7-2.11.0
Installed tag: | 1.3.7-2.11.0
Scenes: | EHC_PAM_main
Accessible by: | 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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveM2_Tx_in:
    Moves the motor to the position marked with this label
- moveM2_Tx_out:
    Moves the motor to the position marked with this label

Release History
1.3.7-2.11.0

Created: | 2021-05-20T15:44:30.000Z
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T13:56:25.000Z
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T14:53:29.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

###### M3TX_BIU

Instance id: | SPB_EHC_PAM/MDL/M3TX_BIU
Class id: | BeamImagingUnit
Host: | spb-rr-sys-con-16
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2021-05-21T17:41:00.000+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Costa, Goeries
Latest tag: | 1.3.7-2.11.0
Deployment tag: | 1.3.7-2.11.0
Installed tag: | 1.3.7-2.11.0
Scenes: | EHC_PAM_main
Accessible by: | 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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveM3_Tx_in:
    Moves the motor to the position marked with this label
- moveM3_Tx_out:
    Moves the motor to the position marked with this label

Release History
1.3.7-2.11.0

Created: | 2021-05-20T15:44:30.000Z
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T13:56:25.000Z
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T14:53:29.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

###### SAMPLE1_Y_BIU

Instance id: | SPB_EHC_PAM/MDL/SAMPLE1_Y_BIU
Class id: | BeamImagingUnit
Host: | spb-rr-sys-con-16
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2021-05-21T17:41:00.000+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Costa, Goeries
Latest tag: | 1.3.7-2.11.0
Deployment tag: | 1.3.7-2.11.0
Installed tag: | 1.3.7-2.11.0
Scenes: | EHC_PAM_main, SPB_EHC_PAM_sample, EHC_PAM_sample
Accessible by: | 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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- movePhotodiode:
    Moves the motor to the position marked with this label
- moveHole:
    Moves the motor to the position marked with this label
- moveYAG_200_um:
    Moves the motor to the position marked with this label
- moveYAG_20_um:
    Moves the motor to the position marked with this label
- moveYAG_100_um:
    Moves the motor to the position marked with this label
- moveCVD_wedged:
    Moves the motor to the position marked with this label
- moveCVD_50_um:
    Moves the motor to the position marked with this label
- moveSi3N4_2_um:
    Moves the motor to the position marked with this label
- moveSnO2_500_nm:
    Moves the motor to the position marked with this label
- moveSnO2_1_um:
    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.7-2.11.0

Created: | 2021-05-20T15:44:30.000Z
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T13:56:25.000Z
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T14:53:29.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

##### MOTOR

[add component documentation]

###### SPECT_GRATING

###### DELAY

###### INCOUPLING1_X

###### INCOUPLING1_Y

###### INCOUPLING2_X

###### INCOUPLING2_Y

###### INCOUPLING_H_SPEC

Instance id: | SPB_EHC_PAM/MOTOR/INCOUPLING_H_SPEC
Class id: | BeckhoffMC2Base
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | EHC_PAM_main, SPB_EHC_PAM_main, SPB_EHC_PAM_SmarAct, EHC_PAM_SmarAct, SPB_EHC_PAM_main, SPB_EHC_PAM_main, SPB_EHC_PAM_SACT
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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.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

###### INCOUPLING_V_SPEC

Instance id: | SPB_EHC_PAM/MOTOR/INCOUPLING_V_SPEC
Class id: | BeckhoffMC2Base
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | EHC_PAM_main, SPB_EHC_PAM_main, SPB_EHC_PAM_SmarAct, EHC_PAM_SmarAct, SPB_EHC_PAM_main, SPB_EHC_PAM_main, SPB_EHC_PAM_SACT
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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.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

###### MIRROR_DOWN_1

Instance id: | SPB_EHC_PAM/MOTOR/MIRROR_DOWN_1
Class id: | BeckhoffMC2Base
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | EHC_PAM_main, SPB_EHC_PAM_main, SPB_EHC_PAM_SmarAct, EHC_PAM_SmarAct, SPB_EHC_PAM_main, SPB_EHC_PAM_main, SPB_EHC_PAM_SACT
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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.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

###### MIRROR_DOWN_2

Instance id: | SPB_EHC_PAM/MOTOR/MIRROR_DOWN_2
Class id: | BeckhoffMC2Base
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | EHC_PAM_main, SPB_EHC_PAM_main, SPB_EHC_PAM_SmarAct, EHC_PAM_SmarAct, SPB_EHC_PAM_main, SPB_EHC_PAM_main, SPB_EHC_PAM_SACT
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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.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

###### MIRROR_UP_1

Instance id: | SPB_EHC_PAM/MOTOR/MIRROR_UP_1
Class id: | BeckhoffMC2Base
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | EHC_PAM_main, SPB_EHC_PAM_main, SPB_EHC_PAM_SmarAct, EHC_PAM_SmarAct, SPB_EHC_PAM_main, SPB_EHC_PAM_main, SPB_EHC_PAM_SACT
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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.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

###### MIRROR_UP_2

Instance id: | SPB_EHC_PAM/MOTOR/MIRROR_UP_2
Class id: | BeckhoffMC2Base
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | EHC_PAM_main, SPB_EHC_PAM_main, SPB_EHC_PAM_SmarAct, EHC_PAM_SmarAct, SPB_EHC_PAM_main, SPB_EHC_PAM_main, SPB_EHC_PAM_SACT
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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.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

###### OUTCOUPLING_H_SPEC

Instance id: | SPB_EHC_PAM/MOTOR/OUTCOUPLING_H_SPEC
Class id: | BeckhoffMC2Base
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | EHC_PAM_main, SPB_EHC_PAM_main, SPB_EHC_PAM_SmarAct, EHC_PAM_SmarAct, SPB_EHC_PAM_main, SPB_EHC_PAM_main, SPB_EHC_PAM_SACT
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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.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

###### OUTCOUPLING_V_SPEC

Instance id: | SPB_EHC_PAM/MOTOR/OUTCOUPLING_V_SPEC
Class id: | BeckhoffMC2Base
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | EHC_PAM_main, SPB_EHC_PAM_main, SPB_EHC_PAM_SmarAct, EHC_PAM_SmarAct, SPB_EHC_PAM_main, SPB_EHC_PAM_main, SPB_EHC_PAM_SACT
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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.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

###### SAMPLE1_ROT

###### SAMPLE1_X

###### SAMPLE1_Y

###### SAMPLE1_Z

###### SAMPLE2_ROT

###### SAMPLE2_X

###### SAMPLE2_Y

###### SAMPLE2_Z

##### SPECTRUM_MONITOR

[add component documentation]

###### SPEC_SIG

###### SPEC_REF

##### IMG

[add component documentation]

###### SPEC_REF

Release History

###### SPEC_SIG

Release History

##### TRIG

[add component documentation]

###### REF

Instance id: | SPB_EHC_PAM/TRIG/REF
Host: | exflcon30n0
Alias: | spb-rr-sys-con-06
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
Installed tag: | 1.2.4-2.6.4
Scenes: | EHC_PAM_TRIG_REF
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.2.4-2.6.4) does not match tags mentioned in the deployment ([‘1.3.2-2.7.0’])!

[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: |

##### M2TX

[add component documentation]

###### MDL

[add component documentation]

BIU

Instance id: | SPB_EHC_PAM_M2TX/MDL/BIU
Host: | exflcon42n0
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2019-10-30T16:09:06.000+01:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Degon, Giovanetti, Mohacsi
Latest tag: | 1.3.5-2.4.0
Deployment tag: | 1.3.5-2.4.0
Installed tag: | 1.3.5-2.4.0
Scenes: | EHC_PAM_main
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

[add instance documentation]

Release History
1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

##### M3TX

[add component documentation]

###### MDL

[add component documentation]

BIU

Instance id: | SPB_EHC_PAM_M3TX/MDL/BIU
Host: | exflcon42n0
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2019-10-30T16:09:06.000+01:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Degon, Giovanetti, Mohacsi
Latest tag: | 1.3.5-2.4.0
Deployment tag: | 1.3.5-2.4.0
Installed tag: | 1.3.5-2.4.0
Scenes: | EHC_PAM_main
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

[add instance documentation]

Release History
1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

##### spectrumTrend

[add component documentation]

###### SPEC_REF

###### SPEC_SIG

#### SCR

[add component documentation]

##### SWITCH

[add component documentation]

###### HOLSTER_X_LIMITL

Instance id: | SPB_EHC_SCR/SWITCH/HOLSTER_X_LIMITL
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-01
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-01
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.4-2.11.1
Scenes: | SPB_TO_MPS_DCTRL_BEAM_MODEM_INTERLOCK, SPB_TO_MPS_DCTRL_BEAM_MODEF_INTERLOCK, SPB_TO_MPS_DCTRL_BEAM_MODES_INTERLOCK, SPB Mode M overview-RB0
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T09:55:43.000Z
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

##### CAM

[add component documentation]

###### CAMERA

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

##### DCTRL

[add component documentation]

###### LED

###### CAMERA

Instance id: | SPB_EHC_SCR/DCTRL/CAMERA
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | SPB_EHC_SCR, SPB_EHC_SCR, SPB_EHC_SCR, SPB_EHC_SCR, SPB_EHC_SCR, SPB_EHC_SCR, Ptychography, SPB_EHC_SCR, EHC_SCR_legacy, SPB_EHC_SCR, EHD_SCR, EHC_PAM_CAM_FF_Laser
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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

###### HOLSTER_X_LIMITL

Instance id: | SPB_EHC_SCR/DCTRL/HOLSTER_X_LIMITL
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-07
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-07
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.4-2.11.1
Scenes: | MPS_interlock_all, MPS_INTERLOCK_IMG_MODE_F, SPB Mode M overview-RB0, MPS_INTERLOCK_IMG, SPB Mode F overview, MPS_INTERLOCK_IMG, SPB Mode M overview, MPS_interlock_all, MPS_INTERLOCK_IMG_MODE_F, MPS-MODE_M, MPS-MODE_M
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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

##### MDL

[add component documentation]

###### BIU

Instance id: | SPB_EHC_SCR/MDL/BIU
Class id: | BeamImagingUnit
Host: | spb-rr-sys-con-16
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2021-05-21T17:41:00.000+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Costa, Goeries
Latest tag: | 1.3.7-2.11.0
Deployment tag: | 1.3.7-2.11.0
Installed tag: | 1.3.7-2.11.0
Scenes: | EHC_SCR, Screen_Overview, CamOverview, CamOverview, EHC_SCR_legacy, SPB_EHU_ALAS_alignment, EHC_SCR_AVG
Accessible by: | 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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveSCR_in:
    Moves the motor to the position marked with this label
- moveSCR_out:
    Moves the motor to the position marked with this label

Release History
1.3.7-2.11.0

Created: | 2021-05-20T15:44:30.000Z
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T13:56:25.000Z
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T14:53:29.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

##### MOTOR

[add component documentation]

###### ZOOM

###### CAMERA_X

###### CAMERA_Z

###### FOCUS

###### HOLSTER_X

##### PROC

[add component documentation]

###### AVG

Instance id: | SPB_EHC_SCR/PROC/AVG
Class id: | ImageAverager
Host: | spb-rr-sys-con-spc
Alias: | spb-rr-sys-con-spc
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: | EHC_SCR_AVG
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.

###### CAMERA

Instance id: | SPB_EHC_SCR/PROC/CAMERA
Class id: | ImageProcessor
Host: | spb-rr-sys-con-spc
Class documentation:
| ImageProcessor
Alias: | spb-rr-sys-con-spc
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: | EHC_PAM_CAM_FF_Laser
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.

#### SON

[add component documentation]

##### MOTOR

[add component documentation]

###### PHU_Z

###### PHD_X

###### PHD_Z

###### PHU_X

##### ENC

[add component documentation]

###### PHU_Z

Instance id: | SPB_EHC_SON/ENC/PHU_Z
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### PHD_X

Instance id: | SPB_EHC_SON/ENC/PHD_X
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### PHD_Z

Instance id: | SPB_EHC_SON/ENC/PHD_Z
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### PHU_X

Instance id: | SPB_EHC_SON/ENC/PHU_X
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

#### SYS

[add component documentation]

##### TSYS

[add component documentation]

###### SPEC_SIG

Instance id: | SPB_EHC_SYS/TSYS/SPEC_SIG
Class id: | X2TimerML
Host: | exflcon30n0
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-08-21T17:17:47.000+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Ehsan, Hickin
Latest tag: | 1.3.3-2.9.1
Deployment tag: | 1.3.3-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

1.0.5-2.1.18

Created: | 2017-10-06T11:33:19.000Z
Author: | Dennis Goeries
Notes: |

###### SPEC_REF

Instance id: | SPB_EHC_SYS/TSYS/SPEC_REF
Class id: | X2TimerML
Host: | exflcon30n0
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2020-08-21T17:17:47.000+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Ehsan, Hickin
Latest tag: | 1.3.3-2.9.1
Deployment tag: | 1.3.3-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.0.6-2.1.18

Created: | 2018-03-05T15:51:54.000Z
Author: | Dennis Goeries
Notes: |

1.0.5-2.1.18

Created: | 2017-10-06T11:33:19.000Z
Author: | Dennis Goeries
Notes: |

#### DPA

[add component documentation]

##### DCTRL

[add component documentation]

###### CAM

Instance id: | SPB_EHC_DPA/DCTRL/CAM
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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

###### LED

##### MOTOR

[add component documentation]

###### CHAMBER_AX

###### CHAMBER_AY

###### CHAMBER_X

###### CHAMBER_Y

###### HOLSTER_X

### EHD

[add component documentation]

#### WFS

[add component documentation]

##### SWITCH

[add component documentation]

###### ZYLA_POW_OK

Instance id: | SPB_EHD_WFS/SWITCH/ZYLA_POW_OK
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

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

###### INT_STATUS

Instance id: | SPB_EHD_WFS/SWITCH/INT_STATUS
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

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

##### ACTRL

[add component documentation]

###### INT_GAIN

Instance id: | SPB_EHD_WFS/ACTRL/INT_GAIN
Class id: | BeckhoffAnalogOutput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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

###### CAM2_FOC

Instance id: | SPB_EHD_WFS/ACTRL/CAM2_FOC
Class id: | BeckhoffAnalogOutput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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

##### DCTRL

[add component documentation]

###### ZYLA_POWCTRL

Instance id: | SPB_EHD_WFS/DCTRL/ZYLA_POWCTRL
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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

###### INT_ACTIVATE

Instance id: | SPB_EHD_WFS/DCTRL/INT_ACTIVATE
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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

###### INT_RESET

Instance id: | SPB_EHD_WFS/DCTRL/INT_RESET
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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

###### IPORT_POW

Instance id: | SPB_EHD_WFS/DCTRL/IPORT_POW
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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

###### UDS_POW

Instance id: | SPB_EHD_WFS/DCTRL/UDS_POW
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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

##### ENC

[add component documentation]

###### T2_Z

Instance id: | SPB_EHD_WFS/ENC/T2_Z
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### CAM1_FOC

Instance id: | SPB_EHD_WFS/ENC/CAM1_FOC
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### CAM1_ZOOM

Instance id: | SPB_EHD_WFS/ENC/CAM1_ZOOM
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### T1_RX

Instance id: | SPB_EHD_WFS/ENC/T1_RX
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### T1_RY

Instance id: | SPB_EHD_WFS/ENC/T1_RY
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### T1_RZ

Instance id: | SPB_EHD_WFS/ENC/T1_RZ
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### T1_X

Instance id: | SPB_EHD_WFS/ENC/T1_X
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### T1_Y

Instance id: | SPB_EHD_WFS/ENC/T1_Y
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### T1_Z

Instance id: | SPB_EHD_WFS/ENC/T1_Z
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### T2_RX

Instance id: | SPB_EHD_WFS/ENC/T2_RX
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### T2_RY

Instance id: | SPB_EHD_WFS/ENC/T2_RY
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### T2_RZ

Instance id: | SPB_EHD_WFS/ENC/T2_RZ
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### T2_X

Instance id: | SPB_EHD_WFS/ENC/T2_X
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### T2_Y

Instance id: | SPB_EHD_WFS/ENC/T2_Y
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

##### MOTOR

[add component documentation]

###### T2_Z

###### CAM1_FOC

###### CAM1_ROT

###### CAM1_ZOOM

###### D1_X

###### D1_Y

###### D2_X

###### D2_Y

###### T1_RX

###### T1_RY

###### T1_RZ

###### T1_X

###### T1_Y

###### T1_Z

###### T2_RX

###### T2_RY

###### T2_RZ

###### T2_X

###### T2_Y

##### ASENS

[add component documentation]

###### CAM2_FOC

Instance id: | SPB_EHD_WFS/ASENS/CAM2_FOC
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

#### BIM

[add component documentation]

##### TSENS

[add component documentation]

###### SCREEN_TB

Instance id: | SPB_EHD_BIM/TSENS/SCREEN_TB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### DIODES_TA

Instance id: | SPB_EHD_BIM/TSENS/DIODES_TA
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### DIODES_TB

Instance id: | SPB_EHD_BIM/TSENS/DIODES_TB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### SCREEN_TA

Instance id: | SPB_EHD_BIM/TSENS/SCREEN_TA
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

##### DCTRL

[add component documentation]

###### SCREEN_LED

###### SCREEN_CAM

Instance id: | SPB_EHD_BIM/DCTRL/SCREEN_CAM
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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

##### ENC

[add component documentation]

###### SCREEN_HOLDER_X

Instance id: | SPB_EHD_BIM/ENC/SCREEN_HOLDER_X
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

##### MOTOR

[add component documentation]

###### SCREEN_HOLDER_X

##### PMOTOR

[add component documentation]

###### DIODE_HOLDER_Z

Instance id: | SPB_EHD_BIM/PMOTOR/DIODE_HOLDER_Z
Class id: | BeckhoffMC2Base
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffMC2Base
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

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.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

#### DG

[add component documentation]

##### TSYS

[add component documentation]

###### TRIG2

Instance id: | SPB_EHD_DG/TSYS/TRIG2
Class id: | X2TimerML
Host: | spb-rr-sys-con-06
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2021-05-07T16:06:25.000+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.0-2.10.4
Deployment tag: | 1.4.0-2.10.4
Scenes: | DG2
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.0-2.10.4

Created: | 2021-05-07T14:01:37.000Z
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

###### BUNCHTRIG

Instance id: | SPB_EHD_DG/TSYS/BUNCHTRIG
Class id: | X2TimerML
Host: | spb-rr-sys-con-06
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2021-05-07T16:06:25.000+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.0-2.10.4
Deployment tag: | 1.4.0-2.10.4
Scenes: | Main, ShimadzuControl
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.0-2.10.4

Created: | 2021-05-07T14:01:37.000Z
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

###### TRIG1

Instance id: | SPB_EHD_DG/TSYS/TRIG1
Class id: | X2TimerML
Host: | spb-rr-sys-con-06
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2021-05-07T16:06:25.000+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.0-2.10.4
Deployment tag: | 1.4.0-2.10.4
Scenes: | Main, ShimadzuControl, DG1
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.0-2.10.4

Created: | 2021-05-07T14:01:37.000Z
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

#### IBS

[add component documentation]

##### TSENS

[add component documentation]

###### DIAMONDDISK_TEMP

Instance id: | SPB_EHD_IBS/TSENS/DIAMONDDISK_TEMP
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ABS1_TEMP

Instance id: | SPB_EHD_IBS/TSENS/ABS1_TEMP
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ABS2_TEMP

Instance id: | SPB_EHD_IBS/TSENS/ABS2_TEMP
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ABS3_TEMP

Instance id: | SPB_EHD_IBS/TSENS/ABS3_TEMP
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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]

###### WAYCON_LVDT

Instance id: | SPB_EHD_IBS/ASENS/WAYCON_LVDT
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### DIAMOND_DISK_Y

Instance id: | SPB_EHD_IBS/ASENS/DIAMOND_DISK_Y
Host: | exflcon44n0
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[add instance documentation]

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

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: |

##### CAM

[add component documentation]

###### 1

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

##### DCTRL

[add component documentation]

###### LED

###### CAMERA

Instance id: | SPB_EHD_IBS/DCTRL/CAMERA
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-2.11.1
Scenes: | IBS_CAM
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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

##### MDL

[add component documentation]

###### BIU

Instance id: | SPB_EHD_IBS/MDL/BIU
Class id: | BeamImagingUnit
Host: | spb-rr-sys-con-16
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2021-05-21T17:41:00.000+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Costa, Goeries
Latest tag: | 1.3.7-2.11.0
Deployment tag: | 1.3.7-2.11.0
Installed tag: | 1.3.7-2.11.0
Scenes: | IBS_CAM, Screen_Overview, Instrument_State_Overview_large, Instrument_State_Overview, Instrument_State_Overview, Instrument_State_Overview
Accessible by: | 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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveDiamond:
    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.7-2.11.0

Created: | 2021-05-20T15:44:30.000Z
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T13:56:25.000Z
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T14:53:29.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

##### MOTOR

[add component documentation]

###### IBS_X

###### DIAMOND_DISK_Y

###### FILTER

#### SCR

[add component documentation]

##### MOTOR

[add component documentation]

###### ZOOM

###### CAMERA_X

###### CAMERA_Z

###### FOCUS

###### HOLSTER_X

###### IRIS

##### DCTRL

[add component documentation]

###### LED

###### CAMERA

Instance id: | SPB_EHD_SCR/DCTRL/CAMERA
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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

##### ENC

[add component documentation]

###### HOLSTER_X

Instance id: | SPB_EHD_SCR/ENC/HOLSTER_X
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### CAMERA_X

Instance id: | SPB_EHD_SCR/ENC/CAMERA_X
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### CAMERA_Z

Instance id: | SPB_EHD_SCR/ENC/CAMERA_Z
Host: | exflcon44n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T14:37:58.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[add instance documentation]

Release History
4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.4-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | reject not finite floating points

4.0.1-2.3.2-set-velocity-when-on

Created: | 2019-06-28T09:36:02.000Z
Author: | silenzi
Notes: | FIX: setting velocity in ON/STOPPED state

4.3.3-2.5.0

Created: | 2019-06-24T17:16:20.000Z
Author: | Alessandro Silenzi
Notes: | epsilon regulation will not send the device to error state.

4.3.2-2.5.0

Created: | 2019-06-21T18:42:18.000Z
Author: | silenzi
Notes: | interlock schema

4.3.1-2.5.0

Created: | 2019-06-21T14:23:31.000Z
Author: | Alessandro Silenzi
Notes: | Fixed schema building

4.3.0-2.5.0

Created: | 2019-06-13T16:36:09.000Z
Author: | Alessandro Silenzi
Notes: | FIX - no updates before device registration - TCP Fixed potential leakage - Tag compatible with the latest karabo updates - autonomous epsilon correction - reduce update messages to one per PLC update call - removed the requestId mutex, using std::atomic FEAT: - message update rate in beckhoffCom

4.2.0-2.4.0

Created: | 2019-05-17T14:12:40.000Z
Author: | Dennis Goeries
Notes: | Expert Access for instatiation FIX: Working around spurious state updates FEAT: review of DAQ Policy FIX: bring back plcBrowseRequest FIX: deviceId is reserved

4.1.1-2.4.0

Created: | 2019-04-16T12:39:27.000Z
Author: | Alessandro Silenzi
Notes: |

4.1.0-2.4.0

Created: | 2019-04-02T10:08:49.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: Refactoring the MC2 Interface FIX: setting velocity in ON/STOPPED state FIX: SimpleMotor coordinated motion deadlock

4.0.1-2.3.2

Created: | 2019-01-09T17:19:27.000Z
Author: | Alessandro Silenzi
Notes: | ￼FIX: Multiple Updates for the same key are kept FIX: Blacklisted confusing slots ￼SCENES: included suggestions from users

4.0.0-2.3.0

Created: | 2018-12-10T13:07:01.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc6-2.3.0rc15

Created: | 2018-12-06T18:43:08.000Z
Author: | Alessandro Silenzi
Notes: |

4.0.0rc5-2.3.0rc14

Created: | 2018-12-05T16:49:51.000Z
Author: | Alessandro Silenzi
Notes: |

##### MDL

[add component documentation]

###### BIU

Instance id: | SPB_EHD_SCR/MDL/BIU
Class id: | BeamImagingUnit
Host: | spb-rr-sys-con-16
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2021-05-21T17:41:00.000+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Costa, Goeries
Latest tag: | 1.3.7-2.11.0
Deployment tag: | 1.3.7-2.11.0
Installed tag: | 1.3.7-2.11.0
Scenes: | Screen_Overview, EHD_SCR
Accessible by: | 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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveSCR_in:
    Moves the motor to the position marked with this label
- moveSCR_out:
    Moves the motor to the position marked with this label

Release History
1.3.7-2.11.0

Created: | 2021-05-20T15:44:30.000Z
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T13:56:25.000Z
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T14:53:29.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

#### VAC

[add component documentation]

##### VALVE

[add component documentation]

###### VALVE_ROUGH_4

Instance id: | SPB_EHD_VAC/VALVE/VALVE_ROUGH_4
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### VALVE_INLINE_1

Instance id: | SPB_EHD_VAC/VALVE/VALVE_INLINE_1
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### VALVE_INLINE_2

Instance id: | SPB_EHD_VAC/VALVE/VALVE_INLINE_2
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### VALVE_INLINE_3

Instance id: | SPB_EHD_VAC/VALVE/VALVE_INLINE_3
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### VALVE_ROUGH_1

Instance id: | SPB_EHD_VAC/VALVE/VALVE_ROUGH_1
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### VALVE_ROUGH_2

Instance id: | SPB_EHD_VAC/VALVE/VALVE_ROUGH_2
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### VALVE_ROUGH_3

Instance id: | SPB_EHD_VAC/VALVE/VALVE_ROUGH_3
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

##### GAUGE

[add component documentation]

###### GAUGE_PR_4

Instance id: | SPB_EHD_VAC/GAUGE/GAUGE_PR_4
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_1

Instance id: | SPB_EHD_VAC/GAUGE/GAUGE_FR_1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_2

Instance id: | SPB_EHD_VAC/GAUGE/GAUGE_FR_2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_3

Instance id: | SPB_EHD_VAC/GAUGE/GAUGE_FR_3
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_4

Instance id: | SPB_EHD_VAC/GAUGE/GAUGE_FR_4
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_PR_1

Instance id: | SPB_EHD_VAC/GAUGE/GAUGE_PR_1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_PR_2

Instance id: | SPB_EHD_VAC/GAUGE/GAUGE_PR_2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_PR_3

Instance id: | SPB_EHD_VAC/GAUGE/GAUGE_PR_3
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

##### SWITCH

[add component documentation]

###### SPARE_DI_2

Instance id: | SPB_EHD_VAC/SWITCH/SPARE_DI_2
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

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

###### SPARE_DI_1

Instance id: | SPB_EHD_VAC/SWITCH/SPARE_DI_1
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

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

##### TPUMP

[add component documentation]

###### PUMP_TURBO_8

Instance id: | SPB_EHD_VAC/TPUMP/PUMP_TURBO_8
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### PUMP_TURBO_1

Instance id: | SPB_EHD_VAC/TPUMP/PUMP_TURBO_1
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### PUMP_TURBO_2

Instance id: | SPB_EHD_VAC/TPUMP/PUMP_TURBO_2
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### PUMP_TURBO_3

Instance id: | SPB_EHD_VAC/TPUMP/PUMP_TURBO_3
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### PUMP_TURBO_4

Instance id: | SPB_EHD_VAC/TPUMP/PUMP_TURBO_4
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### PUMP_TURBO_5

Instance id: | SPB_EHD_VAC/TPUMP/PUMP_TURBO_5
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### PUMP_TURBO_6

Instance id: | SPB_EHD_VAC/TPUMP/PUMP_TURBO_6
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### PUMP_TURBO_7

Instance id: | SPB_EHD_VAC/TPUMP/PUMP_TURBO_7
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

##### TSENS

[add component documentation]

###### SPARE_AI_3

Instance id: | SPB_EHD_VAC/TSENS/SPARE_AI_3
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### SPARE_AI_1

Instance id: | SPB_EHD_VAC/TSENS/SPARE_AI_1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### SPARE_AI_2

Instance id: | SPB_EHD_VAC/TSENS/SPARE_AI_2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

#### HPVX2

[add component documentation]

##### 1

[add component documentation]

###### CAM

[add component documentation]

CAMERA

###### TSYS

[add component documentation]

STBY

Instance id: | SPB_EHD_HPVX2_1/TSYS/STBY
Class id: | X2TimerML
Host: | spb-rr-sys-con-06
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2021-05-07T16:06:25.000+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.0-2.10.4
Deployment tag: | 1.4.0-2.10.4
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.0-2.10.4

Created: | 2021-05-07T14:01:37.000Z
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

TRIG

Instance id: | SPB_EHD_HPVX2_1/TSYS/TRIG
Class id: | X2TimerML
Host: | spb-rr-sys-con-06
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2021-05-07T16:06:25.000+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.0-2.10.4
Deployment tag: | 1.4.0-2.10.4
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.0-2.10.4

Created: | 2021-05-07T14:01:37.000Z
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

##### 2

[add component documentation]

###### MDL

[add component documentation]

SYNCTRG

###### TSYS

[add component documentation]

STBY

Instance id: | SPB_EHD_HPVX2_2/TSYS/STBY
Class id: | X2TimerML
Host: | spb-rr-sys-con-06
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2021-05-07T16:06:25.000+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.0-2.10.4
Deployment tag: | 1.4.0-2.10.4
Scenes: | Shimadzu_HPVX, Timing
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.0-2.10.4

Created: | 2021-05-07T14:01:37.000Z
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

TRIG

Instance id: | SPB_EHD_HPVX2_2/TSYS/TRIG
Class id: | X2TimerML
Host: | spb-rr-sys-con-06
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2021-05-07T16:06:25.000+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.0-2.10.4
Deployment tag: | 1.4.0-2.10.4
Scenes: | Shimadzu_HPVX, Timing
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.0-2.10.4

Created: | 2021-05-07T14:01:37.000Z
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

###### CAM

[add component documentation]

CAMERA

### EHU

[add component documentation]

#### VAC

[add component documentation]

##### VALVE

[add component documentation]

###### VALVE_INLINE_1

Instance id: | SPB_EHU_VAC/VALVE/VALVE_INLINE_1
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-2.11.1
Scenes: | Interlock_Overview, loop2_Interlock_Overview, loop3_Interlock_Overview, loop4_Interlock_Overview, loop1_Interlock_Details, Instrument-Overview-Long, MKB_ALAS_alignment, Interlock for: SPB_EHU_VAC/VALVE/VALVE_INLINE_1, EHU_ALAS_alignment, loop2_Interlock_Details, loop4_Interlock_Details, Global interlock (overview), SPB_MKB_ALAS_alignment, SPB_EHU_ALAS_alignment, Instrument-Overview-Long-NoCRL, SAXS-Instrument-Overview-NotUTD, Overview, Instrument-Overview-Long, EHU_ALAS_alignment, Overview, loop3_Interlock_Details, EHU_ALAS_alignment, EHU_ALAS_alignment, MKB_ALAS_alignment, SPB_MKB_ALAS_alignment, Instrument-Overview-Long, Overview, SPB-Mode-1-overview-RB, MKB_ALAS_alignment, EHU_ALAS_alignment, SPB_EHU_ALAS_alignment, SPB Mode 1 overview, MKB_ALAS_alignment, EHU_ALAS_alignment, MKB_ALAS_alignment, EHU_ALAS_alignment, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, SPB_EHU_ALAS_alignment, MKB_ALAS_alignment, Global interlock (overview), EHU_ALAS_alignment, MPS_INTERLOCK, Overview, Valve_chk, EHU_ALAS_alignment, Valve_chk, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

##### DCTRL

[add component documentation]

###### SPARE

Instance id: | SPB_EHU_VAC/DCTRL/SPARE
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

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

###### GAUGE_FR_1

Instance id: | SPB_EHU_VAC/DCTRL/GAUGE_FR_1
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-2.11.1
Scenes: | Interlock_Overview, loop2_Interlock_Overview, loop3_Interlock_Overview, loop4_Interlock_Overview, loop1_Interlock_Details, loop2_Interlock_Details, loop4_Interlock_Details, Global interlock (overview), loop3_Interlock_Details, Global interlock (overview)
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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

###### GAUGE_FR_2

Instance id: | SPB_EHU_VAC/DCTRL/GAUGE_FR_2
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-2.11.1
Scenes: | Interlock_Overview, loop2_Interlock_Overview, loop3_Interlock_Overview, loop4_Interlock_Overview, loop1_Interlock_Details, loop2_Interlock_Details, loop4_Interlock_Details, Global interlock (overview), loop3_Interlock_Details, Global interlock (overview)
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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

###### PUMP_ION_2_Setpoint

Instance id: | SPB_EHU_VAC/DCTRL/PUMP_ION_2_Setpoint
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-2.11.1
Scenes: | Interlock_Overview, loop2_Interlock_Overview, loop3_Interlock_Overview, loop4_Interlock_Overview, loop1_Interlock_Details, loop2_Interlock_Details, loop4_Interlock_Details, Global interlock (overview), loop3_Interlock_Details, Global interlock (overview)
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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

##### GAUGE

[add component documentation]

###### GAUGE_FR_2

Instance id: | SPB_EHU_VAC/GAUGE/GAUGE_FR_2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-2.11.1
Scenes: | VACUUM_EH, loop1_Interlock_Details, VACUUM_FULL, VACUUM_EH, Instrument-Overview-Long, Overview, VACUUM_EH, Pressure-Plots, Overview, loop2_Interlock_Details, loop4_Interlock_Details, VACUUM_FULL, VACUUM_EH, VACUUM_FULL, Instrument-Overview-Long-NoCRL, VACUUM_FULL2, SAXS-Instrument-Overview-NotUTD, Overview, Instrument-Overview-Long, Overview, loop3_Interlock_Details, Instrument-Overview-Long, Overview, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, VACUUM_EH, VACUUM_FULL2, Overview, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_1

Instance id: | SPB_EHU_VAC/GAUGE/GAUGE_FR_1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-2.11.1
Scenes: | VACUUM_EH, loop1_Interlock_Details, VACUUM_FULL, VACUUM_EH, VACUUM_EH, Pressure-Plots, Interlock for: SPB_EHU_VAC/VALVE/VALVE_INLINE_1, Overview, loop2_Interlock_Details, loop4_Interlock_Details, VACUUM_FULL, VACUUM_EH, VACUUM_FULL, VACUUM_FULL2, loop3_Interlock_Details, VACUUM_EH, VACUUM_FULL2
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

##### IPUMP

[add component documentation]

###### PUMP_ION_2

Instance id: | SPB_EHU_VAC/IPUMP/PUMP_ION_2
Class id: | BeckhoffAgilentIonPump
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-2.11.1
Scenes: | loop1_Interlock_Details, Instrument-Overview-Long, Overview, Pressure-Plots, Overview, loop2_Interlock_Details, loop4_Interlock_Details, Instrument-Overview-Long-NoCRL, VACUUM_FULL2, SAXS-Instrument-Overview-NotUTD, Overview, Instrument-Overview-Long, Overview, loop3_Interlock_Details, Instrument-Overview-Long, Overview, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, VACUUM_FULL2, Overview, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### PUMP_CTRL_1

Instance id: | SPB_EHU_VAC/IPUMP/PUMP_CTRL_1
Class id: | BeckhoffAgilentIonPump
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-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.
- 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.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

###### PUMP_ION_1

Instance id: | SPB_EHU_VAC/IPUMP/PUMP_ION_1
Class id: | BeckhoffAgilentIonPump
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAgilentIonPump
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-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.
- 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.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

##### SWITCH

[add component documentation]

###### PUMP_ION_2_Setpoint

Instance id: | SPB_EHU_VAC/SWITCH/PUMP_ION_2_Setpoint
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-02
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-02
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

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

###### GAUGE_FR_1

Instance id: | SPB_EHU_VAC/SWITCH/GAUGE_FR_1
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-02
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-02
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

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

###### GAUGE_FR_2

Instance id: | SPB_EHU_VAC/SWITCH/GAUGE_FR_2
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-02
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-02
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

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

##### TSENS

[add component documentation]

###### SPARE_2

Instance id: | SPB_EHU_VAC/TSENS/SPARE_2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### SPARE_1

Instance id: | SPB_EHU_VAC/TSENS/SPARE_1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

#### ALAS

[add component documentation]

##### SWITCH

[add component documentation]

###### LASER_SHUTTER_LO

Instance id: | SPB_EHU_ALAS/SWITCH/LASER_SHUTTER_LO
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

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

###### INCOUPLING_MIRROR_LIMITL

Instance id: | SPB_EHU_ALAS/SWITCH/INCOUPLING_MIRROR_LIMITL
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-01
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-01
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.4-2.11.1
Scenes: | SPB_TO_MPS_DCTRL_BEAM_MODEM_INTERLOCK, SPB_TO_MPS_DCTRL_BEAM_MODEF_INTERLOCK, SPB_TO_MPS_DCTRL_BEAM_MODES_INTERLOCK
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T09:55:43.000Z
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

##### DCTRL

[add component documentation]

###### LASER_SHUTTER_COIL

Instance id: | SPB_EHU_ALAS/DCTRL/LASER_SHUTTER_COIL
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-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

###### INCOUPLING_MIRROR_LIMITL

Instance id: | SPB_EHU_ALAS/DCTRL/INCOUPLING_MIRROR_LIMITL
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-2.11.1
Scenes: | MPS_interlock_all, Interlock_Overview, loop2_Interlock_Overview, loop3_Interlock_Overview, loop4_Interlock_Overview, loop1_Interlock_Details, MPS_INTERLOCK_IMG_MODE_F, loop2_Interlock_Details, loop4_Interlock_Details, Global interlock (overview), loop3_Interlock_Details, SPB Mode M overview-RB0, EHU_ALAS_alignment, MPS_INTERLOCK_IMG, SPB Mode S overview, SPB Mode F overview, MPS_INTERLOCK_IMG, Global interlock (overview), MPS_interlock_all, MPS_INTERLOCK_IMG_MODE_F, MPS-MODE_S, MPS-MODE_M, MPS-MODE_S, MPS-MODE_M
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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

##### MDL

[add component documentation]

###### BIU

Instance id: | SPB_EHU_ALAS/MDL/BIU
Class id: | BeamImagingUnit
Host: | spb-rr-sys-con-16
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2021-05-21T17:41:00.000+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Costa, Goeries
Latest tag: | 1.3.7-2.11.0
Deployment tag: | 1.3.7-2.11.0
Installed tag: | 1.3.7-2.11.0
Scenes: | EHU_ALAS_alignment, ALAS_Overview, SPB_EHU_ALAS_alignment, SPB_EHU_ALAS_alignment, EHU_ALAS_alignment
Accessible by: | 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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveALAS_in:
    Moves the motor to the position marked with this label
- moveALAS_out:
    Moves the motor to the position marked with this label

Release History
1.3.7-2.11.0

Created: | 2021-05-20T15:44:30.000Z
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T13:56:25.000Z
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T14:53:29.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

##### MOTOR

[add component documentation]

###### POLARIZER_AZ

###### BREADBOARD_X

###### BREADBOARD_Y

###### INCOUPLING_MIRROR

###### LENS1_Z

###### MIRROR1_AX

###### MIRROR1_AY

###### MIRROR2_AX

###### MIRROR2_AY

#### ATT

[add component documentation]

##### TSENS

[add component documentation]

###### ARM4_TB

Instance id: | SPB_EHU_ATT/TSENS/ARM4_TB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### APERTURE_TA

Instance id: | SPB_EHU_ATT/TSENS/APERTURE_TA
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### APERTURE_TB

Instance id: | SPB_EHU_ATT/TSENS/APERTURE_TB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM1_TA

Instance id: | SPB_EHU_ATT/TSENS/ARM1_TA
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM1_TB

Instance id: | SPB_EHU_ATT/TSENS/ARM1_TB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM2_TA

Instance id: | SPB_EHU_ATT/TSENS/ARM2_TA
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM2_TB

Instance id: | SPB_EHU_ATT/TSENS/ARM2_TB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM3_TA

Instance id: | SPB_EHU_ATT/TSENS/ARM3_TA
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM3_TB

Instance id: | SPB_EHU_ATT/TSENS/ARM3_TB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### ARM4_TA

Instance id: | SPB_EHU_ATT/TSENS/ARM4_TA
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

##### MOTOR

[add component documentation]

###### CHAMY

###### ARM1

###### ARM2

###### ARM3

###### ARM4

###### CHAMX

#### PSLIT

[add component documentation]

##### TSENS

[add component documentation]

###### BLADE_TOP_TB

Instance id: | SPB_EHU_PSLIT/TSENS/BLADE_TOP_TB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### 0APERTURE_TB

Instance id: | SPB_EHU_PSLIT/TSENS/0APERTURE_TB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### APERTURE_TA

Instance id: | SPB_EHU_PSLIT/TSENS/APERTURE_TA
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### BLADE_BOTTOM_TA

Instance id: | SPB_EHU_PSLIT/TSENS/BLADE_BOTTOM_TA
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### BLADE_BOTTOM_TB

Instance id: | SPB_EHU_PSLIT/TSENS/BLADE_BOTTOM_TB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### BLADE_LEFT_TA

Instance id: | SPB_EHU_PSLIT/TSENS/BLADE_LEFT_TA
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### BLADE_LEFT_TB

Instance id: | SPB_EHU_PSLIT/TSENS/BLADE_LEFT_TB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### BLADE_RIGHT_TA

Instance id: | SPB_EHU_PSLIT/TSENS/BLADE_RIGHT_TA
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### BLADE_RIGHT_TB

Instance id: | SPB_EHU_PSLIT/TSENS/BLADE_RIGHT_TB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### BLADE_TOP_TA

Instance id: | SPB_EHU_PSLIT/TSENS/BLADE_TOP_TA
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

##### MDL

[add component documentation]

###### 1

Instance id: | SPB_EHU_PSLIT/MDL/1
Class id: | SlitSystem
Host: | spb-rr-sys-con-03
Alias: | spb-rr-sys-con-03
Git repo: | https://git.xfel.eu/gitlab/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
Projects: | LOOP3, MAIN_copy
Scenes: | EHU_PSLIT_MDL, SPB_EHU_PSLIT/MDL/1|Control, SPB_EHU_PSLIT/MDL/1|SimpleControl, SPB_EHU_PSLIT/MDL/1|Control, SPB_EHU_PSLIT/MDL/1|SimpleControl
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock 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-13T13:43:36.000Z
Author: | David Hickin
Notes: |

2.5.2-2.10.0

Created: | 2020-12-23T15:44:35.000Z
Author: | David Hickin
Notes: |

2.5.1-2.10.0

Created: | 2020-11-19T14:24:45.000Z
Author: | Dennis Goeries
Notes: | Summary: add CI

2.5.0-2.10.0

Created: | 2020-11-19T14:24:45.000Z
Author: | Dennis Goeries
Notes: |

2.4.0-2.2.4

Created: | 2018-06-07T07:11:44.000Z
Author: | Dennis Goeries
Notes: |

2.3.5-2.2.1

Created: | 2018-04-27T09:11:40.000Z
Author: | Dennis Goeries
Notes: |

2.3.4-2.2.1

Created: | 2018-03-22T13:15:20.000Z
Author: | Dennis Goeries
Notes: |

2.3.3-2.2.1

Created: | 2018-03-15T09:55:54.000Z
Author: | Dennis Goeries
Notes: |

2.3.2-2.2.1

Created: | 2018-03-06T12:08:58.000Z
Author: | Dennis Goeries
Notes: |

2.3.1-2.2.1

Created: | 2018-02-19T17:21:55.000Z
Author: | Dennis Goeries
Notes: | Scene update

2.3.0-2.2.1

Created: | 2018-02-19T12:27:25.000Z
Author: | Alessandro Silenzi
Notes: | Included SPB interface and default scenes

2.2.0-2.2.0

Created: | 2017-12-12T16:37:51.000Z
Author: | Dennis Goeries
Notes: |

2.1.9-2.1.16

Created: | 2017-10-23T11:42:52.000Z
Author: | David Hickin
Notes: |

2.1.8-2.1.14

Created: | 2017-08-17T17:23:39.000Z
Author: | Dennis Goeries
Notes: |

2.1.7-2.1.14

Created: | 2017-08-14T13:41:33.000Z
Author: | Dennis Goeries
Notes: |

2.1.6-2.1.12

Created: | 2017-07-19T13:28:26.000Z
Author: | Dennis Goeries
Notes: |

2.1.5

Created: | 2017-03-02T17:29:17.000Z
Author: | Dennis Goeries
Notes: | Migrated slitSystem

##### MOTOR

[add component documentation]

###### BLADE_TOP

###### BLADE_BOTTOM

###### BLADE_LEFT

###### BLADE_RIGHT

#### SCR

[add component documentation]

##### SWITCH

[add component documentation]

###### HOLSTER_LIMITL

Instance id: | SPB_EHU_SCR/SWITCH/HOLSTER_LIMITL
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-01
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-01
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.4-2.11.1
Scenes: | SPB_TO_MPS_DCTRL_BEAM_MODEM_INTERLOCK, SPB_TO_MPS_DCTRL_BEAM_MODEF_INTERLOCK, SPB_TO_MPS_DCTRL_BEAM_MODES_INTERLOCK
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges
- resetCounterRegister:
    Internal

Release History
4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T09:55:43.000Z
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

##### CAM

[add component documentation]

###### CAMERA

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

##### DCTRL

[add component documentation]

###### LED

###### CAMERA

Instance id: | SPB_EHU_SCR/DCTRL/CAMERA
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-2.11.1
Scenes: | SPB_EHU_SCR, SPB_EHU_SCR, EHU_SCR, SPB_EHU_SCR, SPB_EHU_SCR, SPB_EHU_SCR, SPB_EHU_SCR, SPB_EHU_SCR, SPB_EHU_SCR
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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

###### HOLSTER_LIMITL

Instance id: | SPB_EHU_SCR/DCTRL/HOLSTER_LIMITL
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-03
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-03
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.4-2.11.1
Scenes: | MPS_interlock_all, Interlock_Overview, loop2_Interlock_Overview, loop3_Interlock_Overview, loop4_Interlock_Overview, loop1_Interlock_Details, MPS_INTERLOCK_IMG_MODE_F, loop2_Interlock_Details, loop4_Interlock_Details, Global interlock (overview), loop3_Interlock_Details, SPB Mode M overview-RB0, MPS_INTERLOCK_IMG, SPB Mode S overview, SPB Mode F overview, MPS_INTERLOCK_IMG, Global interlock (overview), MPS_interlock_all, MPS_INTERLOCK_IMG_MODE_F, MPS-MODE_M, MPS-MODE_M
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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

##### MDL

[add component documentation]

###### BIU

Instance id: | SPB_EHU_SCR/MDL/BIU
Class id: | BeamImagingUnit
Host: | spb-rr-sys-con-16
Alias: | spb-rr-sys-con-16
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/beamImagingUnit
Last modified: | 2021-05-21T17:41:00.000+02:00
Created at: | 2017-04-04T16:10:05.000+02:00
Main authors: | Teichmann, Costa, Goeries
Latest tag: | 1.3.7-2.11.0
Deployment tag: | 1.3.7-2.11.0
Installed tag: | 1.3.7-2.11.0
Scenes: | EHU_SCR, EHU_ALAS_alignment, Screen_Overview, CamOverview, CamOverview, SPB_EHU_ALAS_alignment, SPB_EHU_ALAS_alignment, EHU_ALAS_alignment, EHU_SCR_AVG
Accessible by: | 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
- extractedLabels:
    Out positions: labels, where the imager is extracted from the beam.
- availableScenes:
    Scenes from the Slit System
- tolerance:
    Position tolerance for increment detection
- moveSCR_in:
    Moves the motor to the position marked with this label
- moveSCR_out:
    Moves the motor to the position marked with this label

Release History
1.3.7-2.11.0

Created: | 2021-05-20T15:44:30.000Z
Author: | Raul Costa
Notes: | Convert ‘yield from’ to ‘await’ (Python 3.8 support).

1.3.6-2.10.0

Created: | 2020-11-19T13:56:25.000Z
Author: | Dennis Goeries
Notes: | scm version

1.3.6-2.9.1

Created: | 2020-09-09T14:53:29.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.5-2.4.0

Created: | 2019-04-08T12:20:52.000Z
Author: | Istvan Mohacsi
Notes: |

1.3.4-2.2.4

Created: | 2019-01-04T13:34:58.000Z
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-17T09:09:48.000Z
Author: | Dennis Goeries
Notes: | Fix tolerance setting, created from master

1.3.2-2.2.4

Created: | 2018-09-19T15:32:10.000Z
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-12T11:49:47.000Z
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-08T12:01:39.000Z
Author: | Dennis Goeries
Notes: | Refactor to table element

1.2.1-2.2.3

Created: | 2018-04-18T14:31:17.000Z
Author: | Dennis Goeries
Notes: |

1.2.0-2.2.2

Created: | 2018-01-23T09:05:56.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.2.0

Created: | 2017-12-12T16:39:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.4-2.1.15

Created: | 2017-10-06T13:36:41.000Z
Author: | Dennis Goeries
Notes: |

1.0.3-2.1.15

Created: | 2017-09-26T12:40:08.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.1.14

Created: | 2017-08-15T13:16:34.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.1.12

Created: | 2017-07-21T16:03:35.000Z
Author: | Dennis Goeries
Notes: |

1.0.0-2.1.12

Created: | 2017-06-20T15:55:03.000Z
Author: | Dennis Goeries
Notes: |

##### MOTOR

[add component documentation]

###### HOLSTER

##### PROC

[add component documentation]

###### AVG

Instance id: | SPB_EHU_SCR/PROC/AVG
Class id: | ImageAverager
Host: | spb-rr-sys-con-spc
Alias: | spb-rr-sys-con-spc
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: | EHU_SCR_AVG
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.

###### IMPROC

Instance id: | SPB_EHU_SCR/PROC/IMPROC
Class id: | ImageProcessor
Host: | spb-rr-sys-con-spc
Class documentation:
| ImageProcessor
Alias: | spb-rr-sys-con-spc
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
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.

### EXP

[add component documentation]

#### ZYLA

[add component documentation]

##### CAM

[add component documentation]

###### 3

Instance id: | SPB_EXP_ZYLA/CAM/3
Class id: | AndorZylaCamera
Host: | spb-rr-sys-con-zyla
Alias: | spb-rr-sys-con-zyla
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/andorZylaCamera
Last modified: | 2019-08-26T12:05:51.000+02:00
Created at: | 2019-01-09T16:08:19.000+01:00
Main authors: | Giovanetti, Mohacsi
Latest tag: | 1.2.5-2.5.0
Deployment tag: | 1.2.5-2.5.0
Scenes: | cam_3, X-Cam, ZylaAllTest, Cam3Test, EHD_WFS_camera, EHD_WFS_Camera
Accessible by: | CONTROLS, CTRL, DA, danilevc, kocha, xdoc

Warning

Installation not found in a standard path!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- outputFrameRate:
    Output frame rate of Karabo device.
- cameraIp:
    The IP address of the camera.
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- pollInterval:
    The interval for polling the camera
- isStrict:
    If true, device goes in error if value is refused from the Hardware
- rebootRcs:
    Reboots the RCS camera controller. Useful after the camera has been power cycled (RCS must always boot AFTER the Zyla camera is powered up)
- imageLatency:
    The difference between image timestamp (got from RCS) and the ‘current’ timestamp (when the image is written to the output channels
- lostFramesRate:
    Average rate of lost frames
- rotation:
    The image rotation.
- acquisitionFrameRate:
    The actual frame rate as set from camera.
- isAcquiring:
    True when camera is acquiring (read from HW)
- exposureTime:
    The exposure time.
- isRunning:
    True when camera is running (read from HW)
- cycleMode:
    Continuous: keep acquiring until acquisition is stopped. Fixed: the camera acquires ‘FrameCount’images and stop automatically.
- frameCount:
    Number of frames to acquire when ‘Fixed’ cycle mode. Ignored in ‘Continuous’ mode.
- triggerMode:
    Configure the camera trigger mode.
- fanOnOff:
    Switch on/off camera fan.
- pixelEncoding:
    Configures the format of data stream.
- electronicShutteringMode:
    On-sensor electronic shuttering mode.For pulsed or fast moving images ‘Global’ shuttering is recommended. For the highest frame rates and best noise performance ‘Rolling’ is recommended.
- imageSizeBytes:
    Size of the image in bytes
- roi:
    ROI in displayed image coordinates (after rotation/flip)
- ccdRoi:
    ROI expressed in original sensor coordinates, i.e. before any rotation or flip is applied
- accumulateCount:
    Sets the number of images that should be summed to obtain each image in sequence.
- roiBinning:
    Sets up pixel binning on the camera.
- roiHorizBinning:
    Configures the Horizontal Binning of the sensor region of interest in CCD coordinates (i.e. before any rotation)
- roiVerticalBinning:
    Configures the Vertical Binning of the sensor region of interest in CCD coordinates (i.e. before any rotation)
- auxiliaryOutSource:
    Configures which signal appears on the auxiliary output pin.
- isFastROIFrameRateEnabled:
    Enables faster framerates at small ROIs.
- ioSelector:
    Selects the IO Pin that you subsequently wish to configure using the IO Invert Feature.
- isIoInverted:
    Indicates whether or not the operation of the IO Pin selected through the IO Selector Feature is inverted.
- isOverlap:
    Enables overlap readout mode.
- pixelReadoutRate:
    Configures the rate of pixel readout from the sensor.
- isSensorCoolingOn:
    Configures the state of the sensor cooling. Cooling is disabled by default at power up and must be enabled for the camera to achieve its target temperature.
- ShutterOutputMode:
    Controls the behavior of the shutter.
- shutterTransferTime:
    Sets the time at which the shutter will be opened before an exposure starts. Can be set between 0 and 100ms at 0.5ms steps. Only available whenever the ExternalTriggerMode is set to ‘Automatic’
- simplePreAmpGainControl:
    Wrapper Feature to simplify selection of the sensitivity and dynamic range options. This feature should be used as a replacement for the PreAmpGainControl feature as some of the options in the PreAmpGainControl feature are not supported on all cameras. Supported Bit Depth will be dependent on the camera. When changing PreAmpGainControl, the PixelEncoding feature will automatically adjust to a default setting for that PreAmpGainControl. For example, if the PreAmpGainControl feature is changed from ‘12-bit (low noise)’ to ‘16-bit (low noise & high well capacity)’ then the PixelEncoding feature will switch automatically to Mono16. This will only occur ifthe PixelEncoding is currently set to Mono12 or Mono12Packed. Similarly, PixelEncoding will switch automatically to either Mono12 or Mono12Packed when the PreAmpGainControl feature is changed from ‘16-bit (low noise & high well capacity)’ to ‘12-bit (low noise)’. When PixelEncoding is set to Mono32, it does not change when PreAmpGainControl is changed.
- isSpuriousNoiseFilterEnabled:
    Enables or Disables the Spurious Noise Filter
- isStaticBlemishCorrectionEnabled:
    Enables or Disables the Static Blemish Correction
- AOILayout:
    AOILayout
- AOIStride:
    AOIStride
- Baseline:
    Baseline
- BitDepth:
    BitDepth
- BytesPerPixel:
    BytesPerPixel
- CameraModel:
    CameraModel
- CameraName:
    CameraName
- CameraPresent:
    CameraPresent
- ControllerID:
    ControllerID
- ExposedPixelHeight:
    ExposedPixelHeight
- ExternalTriggerDelay:
    ExternalTriggerDelay
- FirmwareVersion:
    FirmwareVersion
- FullAOIControl:
    FullAOIControl
- InterfaceType:
    InterfaceType
- LineScanSpeed:
    LineScanSpeed
- MaxInterfaceTransferRate:
    MaxInterfaceTransferRate
- MultitrackBinned:
    MultitrackBinned
- MultitrackCount:
    MultitrackCount
- MultitrackEnd:
    MultitrackEnd
- MultitrackSelector:
    MultitrackSelector
- MultitrackStart:
    MultitrackStart
- PixelHeight:
    PixelHeight
- PixelWidth:
    PixelWidth
- ReadoutTime:
    ReadoutTime
- RowReadTime:
    RowReadTime
- SensorHeight:
    SensorHeight
- SensorTemperature:
    SensorTemperature
- SensorWidth:
    SensorWidth
- SerialNumber:
    SerialNumber
- SoftwareVersion:
    SoftwareVersion
- TemperatureStatus:
    TemperatureStatus
- TimestampClock:
    TimestampClock
- TimestampClockFrequency:
    TimestampClockFrequency

Release History
1.2.5-2.5.0

Created: | 2019-08-20T11:19:58.000Z
Author: | Istvan Mohacsi
Notes: |

1.2.4-2.4.0

Created: | 2019-04-25T14:33:20.000Z
Author: | Gabriele Giovanetti
Notes: |

1.2.4-2.4.0-test-20190425

Created: | 2019-04-24T16:06:53.000Z
Author: | Gabriele Giovanetti
Notes: |

1.1.2-2.3.4

Created: | 2019-03-19T11:14:42.000Z
Author: | Gabriele Giovanetti
Notes: | Fixed ROI stride bug.

1.1.1-2.3.4

Created: | 2019-02-26T13:25:54.000Z
Author: | Gabriele Giovanetti
Notes: | various fixes

1.1.0-2.3.4

Created: | 2019-02-19T18:09:19.000Z
Author: | Gabriele Giovanetti
Notes: | Added reboot RCS slot

1.0.0-2.3.4

Created: | 2019-02-19T08:26:26.000Z
Author: | Gabriele Giovanetti
Notes: | First release

###### 2

Instance id: | SPB_EXP_ZYLA/CAM/2
Class id: | AndorZylaCamera
Host: | spb-rr-sys-con-zyla
Alias: | spb-rr-sys-con-zyla
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/andorZylaCamera
Last modified: | 2019-08-26T12:05:51.000+02:00
Created at: | 2019-01-09T16:08:19.000+01:00
Main authors: | Giovanetti, Mohacsi
Latest tag: | 1.2.5-2.5.0
Deployment tag: | 1.2.5-2.5.0
Scenes: | CAM2, Bazuka_with_DG, EHC_SCR, EHC_ZYLA_Bazuka_Control, Alignment_Overview, Screen_Overview, Bazuka_Control, EHC_SCR_AVG, ZylaAllTest, test2
Accessible by: | CONTROLS, CTRL, DA, danilevc, kocha, xdoc

Warning

Installation not found in a standard path!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO, prepended by package name
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- connectCamera:
    Connects to the hardware
- acquire:
    Instructs camera to go into acquisition state
- trigger:
    Sends a software trigger to the camera
- stop:
    Instructs camera to stop current acquisition
- reset:
    Resets the camera in case of an error
- interfaces:
    Describes the interfaces of this device
- outputFrameRate:
    Output frame rate of Karabo device.
- cameraIp:
    The IP address of the camera.
- failedConnectionAttempts:
    Number of consecutive attempts to connect
- pollInterval:
    The interval for polling the camera
- isStrict:
    If true, device goes in error if value is refused from the Hardware
- rebootRcs:
    Reboots the RCS camera controller. Useful after the camera has been power cycled (RCS must always boot AFTER the Zyla camera is powered up)
- imageLatency:
    The difference between image timestamp (got from RCS) and the ‘current’ timestamp (when the image is written to the output channels
- lostFramesRate:
    Average rate of lost frames
- rotation:
    The image rotation.
- acquisitionFrameRate:
    The actual frame rate as set from camera.
- isAcquiring:
    True when camera is acquiring (read from HW)
- exposureTime:
    The exposure time.
- isRunning:
    True when camera is running (read from HW)
- cycleMode:
    Continuous: keep acquiring until acquisition is stopped. Fixed: the camera acquires ‘FrameCount’images and stop automatically.
- frameCount:
    Number of frames to acquire when ‘Fixed’ cycle mode. Ignored in ‘Continuous’ mode.
- triggerMode:
    Configure the camera trigger mode.
- fanOnOff:
    Switch on/off camera fan.
- pixelEncoding:
    Configures the format of data stream.
- electronicShutteringMode:
    On-sensor electronic shuttering mode.For pulsed or fast moving images ‘Global’ shuttering is recommended. For the highest frame rates and best noise performance ‘Rolling’ is recommended.
- imageSizeBytes:
    Size of the image in bytes
- roi:
    ROI in displayed image coordinates (after rotation/flip)
- ccdRoi:
    ROI expressed in original sensor coordinates, i.e. before any rotation or flip is applied
- accumulateCount:
    Sets the number of images that should be summed to obtain each image in sequence.
- roiBinning:
    Sets up pixel binning on the camera.
- roiHorizBinning:
    Configures the Horizontal Binning of the sensor region of interest in CCD coordinates (i.e. before any rotation)
- roiVerticalBinning:
    Configures the Vertical Binning of the sensor region of interest in CCD coordinates (i.e. before any rotation)
- auxiliaryOutSource:
    Configures which signal appears on the auxiliary output pin.
- isFastROIFrameRateEnabled:
    Enables faster framerates at small ROIs.
- ioSelector:
    Selects the IO Pin that you subsequently wish to configure using the IO Invert Feature.
- isIoInverted:
    Indicates whether or not the operation of the IO Pin selected through the IO Selector Feature is inverted.
- isOverlap:
    Enables overlap readout mode.
- pixelReadoutRate:
    Configures the rate of pixel readout from the sensor.
- isSensorCoolingOn:
    Configures the state of the sensor cooling. Cooling is disabled by default at power up and must be enabled for the camera to achieve its target temperature.
- ShutterOutputMode:
    Controls the behavior of the shutter.
- shutterTransferTime:
    Sets the time at which the shutter will be opened before an exposure starts. Can be set between 0 and 100ms at 0.5ms steps. Only available whenever the ExternalTriggerMode is set to ‘Automatic’
- simplePreAmpGainControl:
    Wrapper Feature to simplify selection of the sensitivity and dynamic range options. This feature should be used as a replacement for the PreAmpGainControl feature as some of the options in the PreAmpGainControl feature are not supported on all cameras. Supported Bit Depth will be dependent on the camera. When changing PreAmpGainControl, the PixelEncoding feature will automatically adjust to a default setting for that PreAmpGainControl. For example, if the PreAmpGainControl feature is changed from ‘12-bit (low noise)’ to ‘16-bit (low noise & high well capacity)’ then the PixelEncoding feature will switch automatically to Mono16. This will only occur ifthe PixelEncoding is currently set to Mono12 or Mono12Packed. Similarly, PixelEncoding will switch automatically to either Mono12 or Mono12Packed when the PreAmpGainControl feature is changed from ‘16-bit (low noise & high well capacity)’ to ‘12-bit (low noise)’. When PixelEncoding is set to Mono32, it does not change when PreAmpGainControl is changed.
- isSpuriousNoiseFilterEnabled:
    Enables or Disables the Spurious Noise Filter
- isStaticBlemishCorrectionEnabled:
    Enables or Disables the Static Blemish Correction

Release History
1.2.5-2.5.0

Created: | 2019-08-20T11:19:58.000Z
Author: | Istvan Mohacsi
Notes: |

1.2.4-2.4.0

Created: | 2019-04-25T14:33:20.000Z
Author: | Gabriele Giovanetti
Notes: |

1.2.4-2.4.0-test-20190425

Created: | 2019-04-24T16:06:53.000Z
Author: | Gabriele Giovanetti
Notes: |

1.1.2-2.3.4

Created: | 2019-03-19T11:14:42.000Z
Author: | Gabriele Giovanetti
Notes: | Fixed ROI stride bug.

1.1.1-2.3.4

Created: | 2019-02-26T13:25:54.000Z
Author: | Gabriele Giovanetti
Notes: | various fixes

1.1.0-2.3.4

Created: | 2019-02-19T18:09:19.000Z
Author: | Gabriele Giovanetti
Notes: | Added reboot RCS slot

1.0.0-2.3.4

Created: | 2019-02-19T08:26:26.000Z
Author: | Gabriele Giovanetti
Notes: | First release

##### BRIDGE

[add component documentation]

###### Z

Instance id: | SPB_EXP_ZYLA/BRIDGE/Z
Host: | exflonc02
Alias: | la1-br-kc-comp-2 , sa1-br-kc-comp-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-02-13T14:25:59.000+01:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Kamil, Michelat, Tmichela
Latest tag: | 2.5.3-2.6.4
Deployment tag: | 2.5.3-2.6.4
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

[add instance documentation]

Release History
2.5.3-2.6.4

Created: | 2019-11-21T12:49:39.000Z
Author: | Thomas Michelat
Notes: |

2.5.2-2.6.1

Created: | 2019-09-05T13:07:41.000Z
Author: | Thomas Michelat
Notes: | Schema Injection workaround for karabo 2.6.1

2.5.1-2.4.0

Created: | 2019-05-06T13:24:28.000Z
Author: | Thomas Michelat
Notes: | bulk properties update on device

2.5.0-2.4.0

Created: | 2019-04-26T11:22:48.000Z
Author: | Ebad Kamil
Notes: | Add default scene

2.4.0-2.4.0

Created: | 2019-04-25T15:15:49.000Z
Author: | Thomas Michelat
Notes: | add option to reshape calibrated detector data (AGIPD and LPD)

2.3.0-2.3.7

Created: | 2019-03-22T13:24:56.000Z
Author: | Thomas Michelat
Notes: | WARNING: device has been renamed from PipeToZeroMQ2 to PipeToZeroMQ2 Make sure you update all your projects after deploying this version.

2.2.1-2.3.5

Created: | 2019-03-06T15:04:31.000Z
Author: | Thomas Michelat
Notes: | BUGFIX: process hanging at destruction if device in passive state

2.2.0-2.2.6

Created: | 2018-10-11T15:29:01.000Z
Author: | Thomas Michelat
Notes: | device refactoring multiple zmq outputs this is a temporary version used for commissioning tests.

2.1.1-2.2.3

Created: | 2018-06-14T16:48:15.000Z
Author: | Thomas Michelat
Notes: | updateSchema implementation seems not reflecting the c++ implemetation or at least do not behave as I expect. we use appendSchema as a replacement until it is worked on. see, https://in.xfel.eu/redmine/issues/26528

2.1.0-2.2.3

Created: | 2018-06-05T16:55:54.000Z
Author: | Thomas Michelat
Notes: | karabo bridge protocol 2.2

2.0.8-2.2.3

Created: | 2018-05-30T17:28:29.000Z
Author: | Thomas Michelat
Notes: | flatten keys for metadata and ImageData, move filtered_keys key to metadata

2.0.7-2.2.3

Created: | 2018-03-27T07:55:44.000Z
Author: | Thomas Michelat
Notes: | pipe test monitoring

2.0.6-2.2.2

Created: | 2018-03-27T07:55:44.000Z
Author: | Thomas Michelat
Notes: |

2.0.5-2.2.2

Created: | 2018-03-21T17:17:27.000Z
Author: | Thomas Michelat
Notes: |

2.0.4-2.2.2

Created: | 2018-03-21T16:47:27.000Z
Author: | Thomas Michelat
Notes: |

2.0.3-2.2.2

Created: | 2018-03-21T16:41:33.000Z
Author: | Thomas Michelat
Notes: |

2.0.2-2.2.2

Created: | 2018-02-19T13:52:04.000Z
Author: | Thomas Michelat
Notes: |

2.0.1-2.2.2

Created: | 2018-02-19T13:52:04.000Z
Author: | Thomas Michelat
Notes: |

2.0.0-2.2.1

Created: | 2018-01-10T14:43:47.000Z
Author: | Thomas Michelat
Notes: | New interface interface: improves performances for serialization

1.1.3-2.1.18

Created: | 2017-11-20T12:24:33.000Z
Author: | Thomas Michelat
Notes: |

###### 2

Instance id: | SPB_EXP_ZYLA/BRIDGE/2
Host: | exflonc02
Alias: | la1-br-kc-comp-2 , sa1-br-kc-comp-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-02-13T14:25:59.000+01:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Kamil, Michelat, Tmichela
Latest tag: | 2.5.3-2.6.4
Deployment tag: | 2.5.3-2.6.4
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

[add instance documentation]

Release History
2.5.3-2.6.4

Created: | 2019-11-21T12:49:39.000Z
Author: | Thomas Michelat
Notes: |

2.5.2-2.6.1

Created: | 2019-09-05T13:07:41.000Z
Author: | Thomas Michelat
Notes: | Schema Injection workaround for karabo 2.6.1

2.5.1-2.4.0

Created: | 2019-05-06T13:24:28.000Z
Author: | Thomas Michelat
Notes: | bulk properties update on device

2.5.0-2.4.0

Created: | 2019-04-26T11:22:48.000Z
Author: | Ebad Kamil
Notes: | Add default scene

2.4.0-2.4.0

Created: | 2019-04-25T15:15:49.000Z
Author: | Thomas Michelat
Notes: | add option to reshape calibrated detector data (AGIPD and LPD)

2.3.0-2.3.7

Created: | 2019-03-22T13:24:56.000Z
Author: | Thomas Michelat
Notes: | WARNING: device has been renamed from PipeToZeroMQ2 to PipeToZeroMQ2 Make sure you update all your projects after deploying this version.

2.2.1-2.3.5

Created: | 2019-03-06T15:04:31.000Z
Author: | Thomas Michelat
Notes: | BUGFIX: process hanging at destruction if device in passive state

2.2.0-2.2.6

Created: | 2018-10-11T15:29:01.000Z
Author: | Thomas Michelat
Notes: | device refactoring multiple zmq outputs this is a temporary version used for commissioning tests.

2.1.1-2.2.3

Created: | 2018-06-14T16:48:15.000Z
Author: | Thomas Michelat
Notes: | updateSchema implementation seems not reflecting the c++ implemetation or at least do not behave as I expect. we use appendSchema as a replacement until it is worked on. see, https://in.xfel.eu/redmine/issues/26528

2.1.0-2.2.3

Created: | 2018-06-05T16:55:54.000Z
Author: | Thomas Michelat
Notes: | karabo bridge protocol 2.2

2.0.8-2.2.3

Created: | 2018-05-30T17:28:29.000Z
Author: | Thomas Michelat
Notes: | flatten keys for metadata and ImageData, move filtered_keys key to metadata

2.0.7-2.2.3

Created: | 2018-03-27T07:55:44.000Z
Author: | Thomas Michelat
Notes: | pipe test monitoring

2.0.6-2.2.2

Created: | 2018-03-27T07:55:44.000Z
Author: | Thomas Michelat
Notes: |

2.0.5-2.2.2

Created: | 2018-03-21T17:17:27.000Z
Author: | Thomas Michelat
Notes: |

2.0.4-2.2.2

Created: | 2018-03-21T16:47:27.000Z
Author: | Thomas Michelat
Notes: |

2.0.3-2.2.2

Created: | 2018-03-21T16:41:33.000Z
Author: | Thomas Michelat
Notes: |

2.0.2-2.2.2

Created: | 2018-02-19T13:52:04.000Z
Author: | Thomas Michelat
Notes: |

2.0.1-2.2.2

Created: | 2018-02-19T13:52:04.000Z
Author: | Thomas Michelat
Notes: |

2.0.0-2.2.1

Created: | 2018-01-10T14:43:47.000Z
Author: | Thomas Michelat
Notes: | New interface interface: improves performances for serialization

1.1.3-2.1.18

Created: | 2017-11-20T12:24:33.000Z
Author: | Thomas Michelat
Notes: |

###### 2_bck

Instance id: | SPB_EXP_ZYLA/BRIDGE/2_bck
Host: | exflonc02
Alias: | la1-br-kc-comp-2 , sa1-br-kc-comp-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-02-13T14:25:59.000+01:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Kamil, Michelat, Tmichela
Latest tag: | 2.5.3-2.6.4
Deployment tag: | 2.5.3-2.6.4
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

[add instance documentation]

Release History
2.5.3-2.6.4

Created: | 2019-11-21T12:49:39.000Z
Author: | Thomas Michelat
Notes: |

2.5.2-2.6.1

Created: | 2019-09-05T13:07:41.000Z
Author: | Thomas Michelat
Notes: | Schema Injection workaround for karabo 2.6.1

2.5.1-2.4.0

Created: | 2019-05-06T13:24:28.000Z
Author: | Thomas Michelat
Notes: | bulk properties update on device

2.5.0-2.4.0

Created: | 2019-04-26T11:22:48.000Z
Author: | Ebad Kamil
Notes: | Add default scene

2.4.0-2.4.0

Created: | 2019-04-25T15:15:49.000Z
Author: | Thomas Michelat
Notes: | add option to reshape calibrated detector data (AGIPD and LPD)

2.3.0-2.3.7

Created: | 2019-03-22T13:24:56.000Z
Author: | Thomas Michelat
Notes: | WARNING: device has been renamed from PipeToZeroMQ2 to PipeToZeroMQ2 Make sure you update all your projects after deploying this version.

2.2.1-2.3.5

Created: | 2019-03-06T15:04:31.000Z
Author: | Thomas Michelat
Notes: | BUGFIX: process hanging at destruction if device in passive state

2.2.0-2.2.6

Created: | 2018-10-11T15:29:01.000Z
Author: | Thomas Michelat
Notes: | device refactoring multiple zmq outputs this is a temporary version used for commissioning tests.

2.1.1-2.2.3

Created: | 2018-06-14T16:48:15.000Z
Author: | Thomas Michelat
Notes: | updateSchema implementation seems not reflecting the c++ implemetation or at least do not behave as I expect. we use appendSchema as a replacement until it is worked on. see, https://in.xfel.eu/redmine/issues/26528

2.1.0-2.2.3

Created: | 2018-06-05T16:55:54.000Z
Author: | Thomas Michelat
Notes: | karabo bridge protocol 2.2

2.0.8-2.2.3

Created: | 2018-05-30T17:28:29.000Z
Author: | Thomas Michelat
Notes: | flatten keys for metadata and ImageData, move filtered_keys key to metadata

2.0.7-2.2.3

Created: | 2018-03-27T07:55:44.000Z
Author: | Thomas Michelat
Notes: | pipe test monitoring

2.0.6-2.2.2

Created: | 2018-03-27T07:55:44.000Z
Author: | Thomas Michelat
Notes: |

2.0.5-2.2.2

Created: | 2018-03-21T17:17:27.000Z
Author: | Thomas Michelat
Notes: |

2.0.4-2.2.2

Created: | 2018-03-21T16:47:27.000Z
Author: | Thomas Michelat
Notes: |

2.0.3-2.2.2

Created: | 2018-03-21T16:41:33.000Z
Author: | Thomas Michelat
Notes: |

2.0.2-2.2.2

Created: | 2018-02-19T13:52:04.000Z
Author: | Thomas Michelat
Notes: |

2.0.1-2.2.2

Created: | 2018-02-19T13:52:04.000Z
Author: | Thomas Michelat
Notes: |

2.0.0-2.2.1

Created: | 2018-01-10T14:43:47.000Z
Author: | Thomas Michelat
Notes: | New interface interface: improves performances for serialization

1.1.3-2.1.18

Created: | 2017-11-20T12:24:33.000Z
Author: | Thomas Michelat
Notes: |

###### 3

Instance id: | SPB_EXP_ZYLA/BRIDGE/3
Host: | exflonc02
Alias: | la1-br-kc-comp-2 , sa1-br-kc-comp-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-02-13T14:25:59.000+01:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Kamil, Michelat, Tmichela
Latest tag: | 2.5.3-2.6.4
Deployment tag: | 2.5.3-2.6.4
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

[add instance documentation]

Release History
2.5.3-2.6.4

Created: | 2019-11-21T12:49:39.000Z
Author: | Thomas Michelat
Notes: |

2.5.2-2.6.1

Created: | 2019-09-05T13:07:41.000Z
Author: | Thomas Michelat
Notes: | Schema Injection workaround for karabo 2.6.1

2.5.1-2.4.0

Created: | 2019-05-06T13:24:28.000Z
Author: | Thomas Michelat
Notes: | bulk properties update on device

2.5.0-2.4.0

Created: | 2019-04-26T11:22:48.000Z
Author: | Ebad Kamil
Notes: | Add default scene

2.4.0-2.4.0

Created: | 2019-04-25T15:15:49.000Z
Author: | Thomas Michelat
Notes: | add option to reshape calibrated detector data (AGIPD and LPD)

2.3.0-2.3.7

Created: | 2019-03-22T13:24:56.000Z
Author: | Thomas Michelat
Notes: | WARNING: device has been renamed from PipeToZeroMQ2 to PipeToZeroMQ2 Make sure you update all your projects after deploying this version.

2.2.1-2.3.5

Created: | 2019-03-06T15:04:31.000Z
Author: | Thomas Michelat
Notes: | BUGFIX: process hanging at destruction if device in passive state

2.2.0-2.2.6

Created: | 2018-10-11T15:29:01.000Z
Author: | Thomas Michelat
Notes: | device refactoring multiple zmq outputs this is a temporary version used for commissioning tests.

2.1.1-2.2.3

Created: | 2018-06-14T16:48:15.000Z
Author: | Thomas Michelat
Notes: | updateSchema implementation seems not reflecting the c++ implemetation or at least do not behave as I expect. we use appendSchema as a replacement until it is worked on. see, https://in.xfel.eu/redmine/issues/26528

2.1.0-2.2.3

Created: | 2018-06-05T16:55:54.000Z
Author: | Thomas Michelat
Notes: | karabo bridge protocol 2.2

2.0.8-2.2.3

Created: | 2018-05-30T17:28:29.000Z
Author: | Thomas Michelat
Notes: | flatten keys for metadata and ImageData, move filtered_keys key to metadata

2.0.7-2.2.3

Created: | 2018-03-27T07:55:44.000Z
Author: | Thomas Michelat
Notes: | pipe test monitoring

2.0.6-2.2.2

Created: | 2018-03-27T07:55:44.000Z
Author: | Thomas Michelat
Notes: |

2.0.5-2.2.2

Created: | 2018-03-21T17:17:27.000Z
Author: | Thomas Michelat
Notes: |

2.0.4-2.2.2

Created: | 2018-03-21T16:47:27.000Z
Author: | Thomas Michelat
Notes: |

2.0.3-2.2.2

Created: | 2018-03-21T16:41:33.000Z
Author: | Thomas Michelat
Notes: |

2.0.2-2.2.2

Created: | 2018-02-19T13:52:04.000Z
Author: | Thomas Michelat
Notes: |

2.0.1-2.2.2

Created: | 2018-02-19T13:52:04.000Z
Author: | Thomas Michelat
Notes: |

2.0.0-2.2.1

Created: | 2018-01-10T14:43:47.000Z
Author: | Thomas Michelat
Notes: | New interface interface: improves performances for serialization

1.1.3-2.1.18

Created: | 2017-11-20T12:24:33.000Z
Author: | Thomas Michelat
Notes: |

###### 4

Instance id: | SPB_EXP_ZYLA/BRIDGE/4
Host: | exflonc02
Alias: | la1-br-kc-comp-2 , sa1-br-kc-comp-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-02-13T14:25:59.000+01:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Kamil, Michelat, Tmichela
Latest tag: | 2.5.3-2.6.4
Deployment tag: | 2.5.3-2.6.4
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

[add instance documentation]

Release History
2.5.3-2.6.4

Created: | 2019-11-21T12:49:39.000Z
Author: | Thomas Michelat
Notes: |

2.5.2-2.6.1

Created: | 2019-09-05T13:07:41.000Z
Author: | Thomas Michelat
Notes: | Schema Injection workaround for karabo 2.6.1

2.5.1-2.4.0

Created: | 2019-05-06T13:24:28.000Z
Author: | Thomas Michelat
Notes: | bulk properties update on device

2.5.0-2.4.0

Created: | 2019-04-26T11:22:48.000Z
Author: | Ebad Kamil
Notes: | Add default scene

2.4.0-2.4.0

Created: | 2019-04-25T15:15:49.000Z
Author: | Thomas Michelat
Notes: | add option to reshape calibrated detector data (AGIPD and LPD)

2.3.0-2.3.7

Created: | 2019-03-22T13:24:56.000Z
Author: | Thomas Michelat
Notes: | WARNING: device has been renamed from PipeToZeroMQ2 to PipeToZeroMQ2 Make sure you update all your projects after deploying this version.

2.2.1-2.3.5

Created: | 2019-03-06T15:04:31.000Z
Author: | Thomas Michelat
Notes: | BUGFIX: process hanging at destruction if device in passive state

2.2.0-2.2.6

Created: | 2018-10-11T15:29:01.000Z
Author: | Thomas Michelat
Notes: | device refactoring multiple zmq outputs this is a temporary version used for commissioning tests.

2.1.1-2.2.3

Created: | 2018-06-14T16:48:15.000Z
Author: | Thomas Michelat
Notes: | updateSchema implementation seems not reflecting the c++ implemetation or at least do not behave as I expect. we use appendSchema as a replacement until it is worked on. see, https://in.xfel.eu/redmine/issues/26528

2.1.0-2.2.3

Created: | 2018-06-05T16:55:54.000Z
Author: | Thomas Michelat
Notes: | karabo bridge protocol 2.2

2.0.8-2.2.3

Created: | 2018-05-30T17:28:29.000Z
Author: | Thomas Michelat
Notes: | flatten keys for metadata and ImageData, move filtered_keys key to metadata

2.0.7-2.2.3

Created: | 2018-03-27T07:55:44.000Z
Author: | Thomas Michelat
Notes: | pipe test monitoring

2.0.6-2.2.2

Created: | 2018-03-27T07:55:44.000Z
Author: | Thomas Michelat
Notes: |

2.0.5-2.2.2

Created: | 2018-03-21T17:17:27.000Z
Author: | Thomas Michelat
Notes: |

2.0.4-2.2.2

Created: | 2018-03-21T16:47:27.000Z
Author: | Thomas Michelat
Notes: |

2.0.3-2.2.2

Created: | 2018-03-21T16:41:33.000Z
Author: | Thomas Michelat
Notes: |

2.0.2-2.2.2

Created: | 2018-02-19T13:52:04.000Z
Author: | Thomas Michelat
Notes: |

2.0.1-2.2.2

Created: | 2018-02-19T13:52:04.000Z
Author: | Thomas Michelat
Notes: |

2.0.0-2.2.1

Created: | 2018-01-10T14:43:47.000Z
Author: | Thomas Michelat
Notes: | New interface interface: improves performances for serialization

1.1.3-2.1.18

Created: | 2017-11-20T12:24:33.000Z
Author: | Thomas Michelat
Notes: |

##### MATCHER

###### 2

###### D

Instance id: | SPB_EXP_ZYLA/MATCHER/D
Class id: | TrainMatcher
Host: | exflonc02
Alias: | sa1-br-kc-comp-2 , la1-br-kc-comp-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/TrainMatcher
Last modified: | 2020-07-30T14:47:26.000+02:00
Created at: | 2018-04-25T15:34:20.000+02:00
Main authors: | Michelat, Tmichela
Latest tag: | 1.0.0-2.7.1
Deployment tag: | 1.0.0-2.7.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- channels:
    list output channel to monitor.
- fastSources:
    Data sources names and configuration from connected output channels
- slowSources:
    Device properties to monitor
- output:
    Output channel for combined train data.
- sent:
    Count how many train data were sent.
- trainId:
    the last trainId data that matched.
- buffer:
    Length of buffer to hold non-complete trains in.

Release History
1.0.0-2.7.1

Created: | 2020-02-18T13:21:57.000Z
Author: | Thomas Michelat
Notes: | Re-implementation: add default scene reconfigurable at run-time: add/remove pipeline connections, add remove fast and slow data) more accurate matching for slow properties train offset for pipeline data show processing info

0.2.1-2.5.0

Created: | 2019-08-27T07:48:16.000Z
Author: | Thomas Michelat
Notes: | add property to allow sending data if input source is missing. add simple implementation of slow data monitor bugfix: handle properly multiple output channel from same device

1.0.0b2-2.4.1

Created: | 2019-05-13T14:44:05.000Z
Author: | Thomas Michelat
Notes: |

0.2.0b1-2.4.0

Created: | 2019-05-03T13:40:27.000Z
Author: | Thomas Michelat
Notes: | simple slow data monitoring, bulked property updates

1.0.0b1-2.4.0

Created: | 2019-03-18T18:50:21.000Z
Author: | Ebad Kamil
Notes: | first “real” try of monitoring slow data (will change)

0.1.0-2.4.0

Created: | 2018-04-27T12:01:19.000Z
Author: | Thomas Michelat
Notes: |

##### PROC

[add component documentation]

###### 1

Instance id: | SPB_EXP_ZYLA/PROC/1
Class id: | ImageProcessor
Host: | spb-rr-sys-con-spc
Class documentation:
| ImageProcessor
Alias: | spb-rr-sys-con-spc
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: | IRU_SIDEMIC_avg, SIDEMIC_BEAM_proc
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.

#### SYS

[add component documentation]

##### TSYS

[add component documentation]

###### UTC_1_S3

Instance id: | SPB_EXP_SYS/TSYS/UTC_1_S3
Class id: | X2Timer
Host: | spb-rr-sys-con-06
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/doocsDevices
Last modified: | 2021-06-15T11:00:23.000+02:00
Created at: | 2018-03-15T13:53:30.000+01:00
Main authors: | Mamchykd, Hauf, Parenti
Latest tag: | 1.8.14-2.11.1
Deployment tag: | 1.8.14-2.11.1
Installed tag: | 1.8.12-2.10.4
Scenes: | agipd_overview, Clock-and-Control, Clock-and-Control, overview, agipd_overview, Clock and Control , AGIPD control - Firmware tests, agipd_overview, agipd_overview, agipd_compact_monitoring_overview, Shimadzu_HPVX, agipd_overview, Timing
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (1.8.12-2.10.4) does not match tags mentioned in the deployment ([‘1.8.14-2.11.1’])!

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- reconnectInterval:
    Reconnect Interval to DOOCS in case of ERROR
- location:
    Location identifies DOOCS server like FACILITY/DEVICE/LOCATION
- bunchPatternDelay:
    Delay of the bunch pattern as a whole. Only triggers using the bunch pattern will be affected.
- updateInterval:
    The interval for updating the x2Timer for read-out values.

Release History
1.8.14-2.11.1

Created: | 2021-06-08T13:36:50.000Z
Author: | Gabriele Giovanetti
Notes: | fix DEPENDS

1.8.13-2.11.1

Created: | 2021-05-19T12:26:44.000Z
Author: | Steffen Hauf
Notes: | Merge branch ‘feat/mirror_scene’ into ‘master’

1.8.12-2.10.4

Created: | 2021-05-05T10:20:05.000Z
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-21T14:09:17.000Z
Author: | Alessandro Silenzi
Notes: | FIX: cast delay to integer to comply with Karabo 2.11

1.8.10-2.10.2

Created: | 2021-02-10T14:47:03.000Z
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-12T12:38:56.000Z
Author: | Andrea Parenti
Notes: | Summary: * FEATURE inject runtime properties; * FIX initialization of DoocsOpticalDelay.

1.8.8-2.10.0

Created: | 2020-11-24T07:05:35.000Z
Author: | Steffen Hauf
Notes: |

1.8.7-2.9.4

Created: | 2020-11-12T15:46:42.000Z
Author: | Riccardo Fabbri
Notes: | Authorization to write to DOOCS retrieved at property level

1.8.6-2.9.4-fxe-xgmd

Created: | 2020-10-09T14:11:02.000Z
Author: | ehsanw
Notes: | to be used for fxe-xgmd

1.8.6-2.9.4

Created: | 2020-10-07T05:37:53.000Z
Author: | Steffen Hauf
Notes: | Add laser steering to bunch pattern pulser

1.8.5-2.9.1-xgm-log-timestamps

Created: | 2020-09-24T18:09:47.000Z
Author: | ehsanw
Notes: | Added timestamp and train id logging for xgm

1.8.5-2.9.1

Created: | 2020-09-15T07:18:47.000Z
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-02T07:35:59.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Description field added to the table.

1.8.3-2.9.1

Created: | 2020-08-26T10:18:01.000Z
Author: | Wajid Ehsan
Notes: | Bunch Arrival Monitor new parameters

1.8.2-2.9.1

Created: | 2020-08-26T09:20:59.000Z
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-21T11:49:45.000Z
Author: | Steffen Hauf
Notes: | Updates for the bunch pattern pulse

1.8.0-2.9.1-sqs-pattern-delay

Created: | 2020-08-20T12:42:42.000Z
Author: | bondarv
Notes: | For tests only. X2Timer in SQS with additional expected parameter “bunchPatternDelay”

1.8.0-2.9.1

Created: | 2020-08-07T15:10:21.000Z
Author: | Steffen Hauf
Notes: | Add the DoocsMirror device

1.7.0-2.9.1

Created: | 2020-08-05T09:24:35.000Z
Author: | Steffen Hauf
Notes: | Add BunchPatternPulser Device

1.6.7-2.9.1

Created: | 2020-08-04T16:57:39.000Z
Author: | mamchykd
Notes: | Updates for DoocsUndulatorCells device (fix for a proper xml structure and calculation of lastClosedUndulator property value). The tag is ok for deployment

###### TIMESERVER

Instance id: | SPB_EXP_SYS/TSYS/TIMESERVER
Class id: | TimeServer
Host: | spb-exp-sys-utc-1
Class documentation:
| TimeServer
Alias: | exflutc109-mch , exflutca109-mch , exflqr19805-mch
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/timeServer
Last modified: | 2021-06-08T10:36:21.000+02:00
Created at: | 2016-12-02T14:04:29.000+01:00
Main authors: | Hauf, Haufs, Fabbri
Latest tag: | 2.8.1-2.11.1
Deployment tag: | 2.8.1-2.11.1
Installed tag: | 2.8.1-2.11.1
Accessible by: | CONTROLS, CTRL, DET, babies, 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-10T15:51:00.000Z
Author: | Gabriele Giovanetti
Notes: | ‘update-copied-headers’ into ‘master’

2.8.0-2.10.0

Created: | 2021-02-05T10:41:17.000Z
Author: | Gero Flucke
Notes: | Fix bugs on period, C++14, fix CI

2.7.6-2.10.0

Created: | 2020-11-24T07:08:35.000Z
Author: | Steffen Hauf
Notes: |

2.7.5-2.9.1

Created: | 2020-09-21T12:07:33.000Z
Author: | Alessandro Silenzi
Notes: | Skip ticks with bad periods and added a bunch of instrumentation

2.7.4-2.9.1

Created: | 2020-08-17T09:38:17.000Z
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-22T14:18:32.000Z
Author: | Riccardo Fabbri
Notes: | Added slot for toggling data processing.

2.7.2-2.9.1

Created: | 2020-07-08T20:40:51.000Z
Author: | Riccardo Fabbri
Notes: | PplBunchPatternStats: Node maxBufferLength is reconfigurable.

2.7.1-2.9.1

Created: | 2020-06-26T17:26:19.000Z
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-27T13:47:21.000Z
Author: | Steffen Hauf
Notes: |

2.7.0-2.9

Created: | 2020-05-27T13:47:21.000Z
Author: | Steffen Hauf
Notes: | Bunch patterns as digests, add a BunchPatternStats device

2.6.0-2.7

Created: | 2020-02-12T14:34:09.000Z
Author: | Gero Flucke
Notes: | Introduce average difference of id increase and add alarms to it

2.5.3-2.4.0

Created: | 2019-05-07T14:35:38.000Z
Author: | Alessandro Silenzi
Notes: | Avoid System Crashes on multiple instances

2.5.2-2.3.3

Created: | 2019-01-23T09:01:43.000Z
Author: | Alessandro Silenzi
Notes: | FEAT: avoid namespace collision with pcLayer

2.5.1-2.3.0

Created: | 2018-12-10T13:26:22.000Z
Author: | Alessandro Silenzi
Notes: | added DAQ Policy

2.5.0-2.2.6

Created: | 2018-11-29T15:54:33.000Z
Author: | Alessandro Silenzi
Notes: | Added read Bunch Pattern table feature

2.4.0-2.1.15

Created: | 2018-02-27T10:18:55.000Z
Author: | Gero Flucke
Notes: | Publish signalled trainIds to data logger

2.3.2-2.1.15

Created: | 2017-09-14T13:41:19.000Z
Author: | Sergey Esenov
Notes: | Fix SIGFPE in signalHandler

2.3.1-2.1.15

Created: | 2017-08-25T08:54:38.000Z
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-20T12:55:53.000Z
Author: | Sergey Esenov
Notes: |

2.2.0-2.1.12

Created: | 2017-06-12T13:43:27.000Z
Author: | esenov
Notes: |

###### BACK_TRG3

Instance id: | SPB_EXP_SYS/TSYS/BACK_TRG3
Class id: | X2TimerML
Host: | spb-rr-sys-con-06
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2021-05-07T16:06:25.000+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.0-2.10.4
Deployment tag: | 1.4.0-2.10.4
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.0-2.10.4

Created: | 2021-05-07T14:01:37.000Z
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

###### BACK_TRG4

Instance id: | SPB_EXP_SYS/TSYS/BACK_TRG4
Class id: | X2TimerML
Host: | spb-rr-sys-con-06
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2021-05-07T16:06:25.000+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.0-2.10.4
Deployment tag: | 1.4.0-2.10.4
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.0-2.10.4

Created: | 2021-05-07T14:01:37.000Z
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

##### DG

[add component documentation]

###### DG2

###### DG1

#### KOHZU-1

[add component documentation]

##### MOTOR

[add component documentation]

###### ARIES_1

###### ARIES_2

###### ARIES_3

###### ARIES_4

###### ARIES_5

###### ARIES_6

###### ARIES_7

###### ARIES_8

### GENERIC

[add component documentation]

#### PROC

[add component documentation]

##### IMPROC

Instance id: | SPB_GENERIC/PROC/IMPROC
Class id: | ImageProcessor
Host: | exflcon45n0
Class documentation:
| ImageProcessor
Alias: | spb-rr-sys-con-spc
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2020-07-31T11:50:20.000+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Fabbri, Giovanetti
Latest tag: | 1.27.4-2.9.1
Deployment tag: | 1.27.4-2.9.1
Scenes: | imgProc_image_mean, SimulatedCameraPy, BeamFit
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

###### Image Processor

The `ImageProcessor` device is documented in imageprocessor:image-processor-user

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- inFrameRate:
    The input frame rate.
- resetError:
    Reset error count.
- reset:
    Resets the processor output values.
- useAsBackgroundImage:
    Use the current image as background image.
- imagePath:
    Input image path.
- filterImagesByThreshold:
    If True, images will be only processed if maximum pixel value exceeds user’s defined threshold.
- imageThreshold:
    The threshold for processing an image.
- absolutePositions:
    If True, the centre-of-mass and fit results will take into account the current settings for ROI and binning.
- subtractBkgImage:
    Subtract the loaded background image.
- subtractImagePedestal:
    Subtract the image pedestal (ie image = image - image.min()). This is done after background subtraction.
- doMinMaxMean:
    Get the following information from the pixels: min, max, mean value.
- doBinCount:
    Calculate the frequency distribution of pixel values.
- doXYSum:
    Integrate the image along the x- and y-axes.
- doCOfM:
    Calculate centre-of-mass and widths.
- do1DFit:
    Perform a 1D gaussian fit of the x- and y-distributions.
- do2DFit:
    Perform a 2D gaussian fits.Be careful: It can be slow!
- doIntegration:
    Perform integration over region.
- clipValues:
    Removes values outside of Integration Threshold Range from the calculation of the integral and region mean.
- comRange:
    The range to be used for the centre-of-mass calculation. Can be the full range, or a user-defined one.
- userDefinedRange:
    The user-defined range for centre-of-mass, gaussian fit(s) and integrals along the x & y axes. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- absThreshold:
    Pixels below this threshold will not be used for the centre-of-mass calculation. If greater than 0, the relative threshold will not be used.
- threshold:
    Pixels below this relative threshold (fraction of the highest value) will not be used for the centre-of-mass calculation. It will only be applied if no absolute threshold is set.
- pixelSize:
    The pixel size. It will be used when evaluating the beam size.
- fitRange:
    The range to be used for fitting. Can be the full range, an auto-determined, or the user-defined one.
- rangeForAuto:
    The automatic range for ‘auto’ mode (in standard deviations).
- enablePolynomial:
    Add a 1st order polynomial term (ramp) to gaussian fits.
- gauss1dStartValues:
    Selects how 1D gauss fit starting values are evaluated
- doGaussRotation:
    Allow the 2D gaussian to be rotated.
- integrationRegion:
    The region to be integrated over. Region [lowX, highX) x [lowY, highY) specified as [lowX, highX, lowY, highY]
- thresholdRange:
    Range of values to be considered in the calculation of Region Integral and Region Mean. Values outside of this range will be set to zero.
- imageWidth:
    The width of the incoming image.
- imageOffsetX:
    If the incoming image has a ROI, this represents the X position of the top-left corner.
- imageBinningX:
    The image binning in the X direction.
- imageHeight:
    The height of the incoming image. Set to 1 for 1D images (spectra).
- imageOffsetY:
    If the incoming image has a ROI, this represents the Y position of the top-left corner. Set to 0 for 1D images (spectra).
- imageBinningY:
    The image binning in the Y direction. Set to 1 for 1D images (spectra).
- minPxValue:
    The minimum image pixel value.
- maxPxValue:
    The maximum image pixel value.
- meanPxValue:
    The mean image pixel value.
- minMaxMeanTime:
    Time spent for evaluating min, max, mean pixel value.
- binCountTime:
    Time spent for calculating the frequency distribution of pixel values.
- subtractBkgImageTime:
    Time spent in subtracting the background image.
- subtractPedestalTime:
    Time spent in subtracting the image pedestal.
- xYSumTime:
    Time spent in integrating the image in X and Y.
- cOfMTime:
    Time spent in evaluating the centre-of-mass.
- xFitTime:
    Time spent in 1D Gaussian fit of the X distribution.
- yFitTime:
    Time spent in 1D Gaussian fit of the Y distribution.
- fitTime:
    Time spent in 2D Gaussian fit of the image.
- integrationTime:
    Time spent in integrating over a region.
- x0:
    X position of the centre-of-mass.
- sx:
    Standard deviation in X of the centre-of-mass.
- y0:
    Y position of the centre-of-mass.
- sy:
    Standard deviation in Y of the centre-of-mass.
- xFitSuccess:
    1D Gaussian fit success (1-4 if fit converged).
- ax1d:
    Amplitude Ax from the 1D fit.
- x01d:
    x0 from 1D Fit.
- ex01d:
    Uncertainty on x0 estimation.
- sx1d:
    Standard deviation on x0 from 1D fit.
- esx1d:
    Uncertainty on standard deviation estimation.
- beamWidth1d:
    Beam width from 1D Fit. Defined as 4x sigma_x.
- yFitSuccess:
    1D Gaussian Fit Success (1-4 if fit converged).
- ay1d:
    Amplitude Ay from 1D fit.
- y01d:
    y0 from 1D Fit.
- ey01d:
    Uncertainty on y0 estimation.
- sy1d:
    Standard deviation on y0 from 1D fit.
- esy1d:
    Uncertainty on standard deviation estimation.
- beamHeight1d:
    Beam heigth from 1D Fit. Defined as 4x sigma_y.
- fitSuccess:
    2D Gaussian fit success (1-4 if fit converged).
- a2d:
    Amplitude from 2D fit.
- x02d:
    x0 from 2D Fit.
- ex02d:
    Uncertainty on x0 estimation.
- sx2d:
    Standard deviation on x0 from 2D fit.
- esx2d:
    Uncertainty on standard deviation estimation.
- beamWidth2d:
    Beam width from 2D Fit. Defined as 4x sigma_x.
- y02d:
    y0 from 2D Fit.
- ey02d:
    Uncertainty on y0 estimation.
- sy2d:
    Standard deviation on y0 from 2D fit.
- esy2d:
    Uncertainty on standard deviation estimation.
- beamHeight2d:
    Beam height from 2D Fit. Defined as 4x sigma_y.
- theta2d:
    Rotation angle from 2D fit.
- etheta2d:
    Uncertainty on rotation angle estimation.
- regionIntegral:
    Integral of pixel value over region specified by integrationRegion.
- regionMean:
    Mean pixel value over region specified by integrationRegion.

Release History
1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

1.17.0-2.3.4

Created: | 2019-02-19T12:53:14.000Z
Author: | Andrea Parenti
Notes: | Add ROI to the TwoPeakFinder device

##### BEAM_SHAPE_COARSE

Instance id: | SPB_GENERIC/PROC/BEAM_SHAPE_COARSE
Class id: | BeamShapeCoarse
Host: | spb-rr-sys-con-spc
Alias: | spb-rr-sys-con-spc
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/imageProcessor
Last modified: | 2021-04-16T14:14:01.000+02:00
Created at: | 2016-11-16T14:12:17.000+01:00
Main authors: | Parenti, Hauf, Fabbri
Latest tag: | 1.27.4-2.10.0
Deployment tag: | 1.27.4-2.10.0
Installed tag: | 1.27.4-2.10.0
Scenes: | imgProc_beam_shape_coarse
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

###### Beam Shape Coarse

The `BeamShapeCoarse` device is part of the imageProcessor package, and is documented in imageprocessor:image-beam-shape-user

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- x0:
    X coordinate of the maximum intensity pixel.
- y0:
    Y coordinate of the maximum intensity pixel.
- fwhmX:
    Full Width at Half Maximum for X projection, A.K.A. beam width.
- fwhmY:
    Full Width at Half Maximum for Y projection, A.K.A. beam height.
- frameRate:
    Rate of processed images.
- resetError:
    Reset error count.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

#### MDL

[add component documentation]

##### BW_AVG

### IRDA

[add component documentation]

#### RRN

[add component documentation]

##### MOTOR

[add component documentation]

###### PPLA_Z

###### BMGD_DNS_X

###### BMGD_DNS_Y

###### BMGD_UPS_X

###### BMGD_UPS_Y

###### BMGD_Z

###### GON_X

###### GON_Y

###### GON_Z

###### INMIC_AX

###### INMIC_AY

###### INMIC_X

###### INMIC_Y

###### INMIC_Z

###### PPLA_X

###### PPLA_Y

##### CTRL

[add component documentation]

###### JNGFR

#### EXP

[add component documentation]

##### CAM

[add component documentation]

###### 2

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

#### JNGFR

[add component documentation]

##### TSYS

[add component documentation]

###### TRIG2

Instance id: | SPB_IRDA_JNGFR/TSYS/TRIG2
Class id: | X2TimerML
Host: | spb-rr-sys-con-06
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2021-05-07T16:06:25.000+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.0-2.10.4
Deployment tag: | 1.4.0-2.10.4
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.0-2.10.4

Created: | 2021-05-07T14:01:37.000Z
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

##### CAL

[add component documentation]

###### MANAGER

Instance id: | SPB_IRDA_JNGFR/CAL/MANAGER
Host: | exflong02
Alias: | spb-br-sys-cal-2 , sa1-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-02-14T16:08:21.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Karnevskiy, Karnem, Hauf
Latest tag: | 1.11.3-2.7.0
Deployment tag: | 1.11.1-2.7.0
Scenes: | CORRECTED_PREVIEW, SPB/SFX_Jungfrau, preview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

[add instance documentation]

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Release History
1.11.3-2.7.0

Created: | 2020-02-11T17:05:43.000Z
Author: | Thomas Michelat
Notes: | Update dependencies

1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.2-2.6.1

Created: | 2019-09-03T14:55:44.000Z
Author: | Steffen Hauf
Notes: |

1.10.1-2.5.0

Created: | 2019-08-29T10:54:11.000Z
Author: | Steffen Hauf
Notes: |

1.10.0-2.5.0

Created: | 2019-08-27T11:42:31.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.5.0

Created: | 2019-07-30T08:24:38.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.4.1-test

Created: | 2019-07-18T09:59:08.000Z
Author: | Steffen Hauf
Notes: |

1.9.1-2.4.1

Created: | 2019-07-18T07:20:27.000Z
Author: | Steffen Hauf
Notes: |

1.9.0-2.4.1

Created: | 2019-07-12T08:41:23.000Z
Author: | Steffen Hauf
Notes: |

1.8.0-2.4.1

Created: | 2019-07-02T09:29:57.000Z
Author: | Steffen Hauf
Notes: |

1.7.1-2.4.1

Created: | 2019-05-16T11:18:46.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1

Created: | 2019-05-16T09:01:21.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1-dev

Created: | 2019-05-13T09:03:00.000Z
Author: | Steffen Hauf
Notes: |

1.6.0-2.4.1

Created: | 2019-05-02T07:58:11.000Z
Author: | Steffen Hauf
Notes: |

1.5.0-2.4.1-dev

Created: | 2019-04-29T06:41:50.000Z
Author: | Steffen Hauf
Notes: |

###### APPEND

Instance id: | SPB_IRDA_JNGFR/CAL/APPEND
Host: | exflong02
Alias: | spb-br-sys-cal-2 , sa1-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/cppFemCombiner
Last modified: | 2020-02-11T18:00:48.000+01:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Hauf, Samartsev, Dave741
Latest tag: | 1.3.2-2.7.1
Deployment tag: | 1.3.1-2.5.0
Scenes: | CORRECTED_PREVIEW, preview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

[add instance documentation]

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Release History
1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

0.2-2.2.3.5

Created: | 2018-05-22T07:47:19.000Z
Author: | Steffen Hauf
Notes: |

0.1-2.2.3.5

Created: | 2018-05-15T13:16:05.000Z
Author: | Steffen Hauf
Notes: |

###### COMBINER

Instance id: | SPB_IRDA_JNGFR/CAL/COMBINER
Host: | exflong02
Alias: | spb-br-sys-cal-2 , sa1-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/femDataSplitter
Last modified: | 2020-01-31T12:07:01.000+01:00
Created at: | 2017-03-10T08:22:26.000+01:00
Main authors: | Samartsev, Hauf, Kamil
Latest tag: | 1.3.1-2.7.0
Deployment tag: | 1.3.0-2.4.1
Scenes: | CORRECTED_PREVIEW, preview
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

[add instance documentation]

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Release History
1.3.1-2.7.0

Created: | 2020-01-28T09:49:16.000Z
Author: | scsonc
Notes: | 28.01.2020

1.3.0-2.4.1

Created: | 2019-05-02T08:14:16.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.3.4

Created: | 2019-02-08T12:54:06.000Z
Author: | Steffen Hauf
Notes: |

1.1.1-2.2.4

Created: | 2018-07-20T11:55:37.000Z
Author: | Andrea Parenti
Notes: | FIX ImageData encoding

1.1.0-2.2.3.5

Created: | 2018-05-17T06:20:59.000Z
Author: | Steffen Hauf
Notes: |

1.0.15-2.2.0

Created: | 2018-05-09T06:31:55.000Z
Author: | Steffen Hauf
Notes: |

1.0.14-2.2.0

Created: | 2018-03-27T07:31:11.000Z
Author: | Thomas Michelat
Notes: |

1.0.13-2.2.0

Created: | 2018-02-28T15:23:55.000Z
Author: | Dennis Goeries
Notes: |

1.0.12-2.2.0

Created: | 2018-02-23T09:45:16.000Z
Author: | Steffen Hauf
Notes: |

1.0.11-2.2.0

Created: | 2018-02-06T15:57:13.000Z
Author: | Steffen Hauf
Notes: |

1.0.10-2.2.0

Created: | 2018-01-15T09:43:49.000Z
Author: | Steffen Hauf
Notes: |

1.0.9-2.1.18

Created: | 2017-11-08T13:00:30.000Z
Author: | Thomas Michelat
Notes: |

1.0.8-2.1.18

Created: | 2017-11-08T09:40:13.000Z
Author: | Thomas Michelat
Notes: |

1.0.7-2.1.15

Created: | 2017-08-31T07:19:57.000Z
Author: | Thomas Michelat
Notes: |

1.0.6-2.1.12

Created: | 2017-08-21T07:13:12.000Z
Author: | Steffen Hauf
Notes: |

1.0.5-2.1.12

Created: | 2017-08-17T06:08:37.000Z
Author: | Steffen Hauf
Notes: |

1.0.4-2.1.12

Created: | 2017-08-11T10:51:58.000Z
Author: | Steffen Hauf
Notes: |

1.0.3-2.1.12

Created: | 2017-08-10T06:08:02.000Z
Author: | Steffen Hauf
Notes: |

1.0.2-2.1.12

Created: | 2017-08-09T12:32:58.000Z
Author: | Steffen Hauf
Notes: |

1.0.1-2.1.12

Created: | 2017-07-10T08:39:14.000Z
Author: | Steffen Hauf
Notes: | First release (patch) for hutch installation. This tags the same hash as 1.0-2.1.12 but it uses the expected tagging convention used by the deployment infrastructure.

###### CORR_GAIN_M1

Instance id: | SPB_IRDA_JNGFR/CAL/CORR_GAIN_M1
Host: | exflong02
Alias: | spb-br-sys-cal-2 , sa1-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-02-05T15:37:58.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Karnevskiy, Karnem, Hauf
Latest tag: | 1.11.2-2.7.0
Deployment tag: | 1.11.1-2.7.0
Installed tag: | 1.9.0-2.4.1
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

The installed tag (1.9.0-2.4.1) does not match tags mentioned in the deployment ([‘1.11.1-2.7.0’])!

[add instance documentation]

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Release History
1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.2-2.6.1

Created: | 2019-09-03T14:55:44.000Z
Author: | Steffen Hauf
Notes: |

1.10.1-2.5.0

Created: | 2019-08-29T10:54:11.000Z
Author: | Steffen Hauf
Notes: |

1.10.0-2.5.0

Created: | 2019-08-27T11:42:31.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.5.0

Created: | 2019-07-30T08:24:38.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.4.1-test

Created: | 2019-07-18T09:59:08.000Z
Author: | Steffen Hauf
Notes: |

1.9.1-2.4.1

Created: | 2019-07-18T07:20:27.000Z
Author: | Steffen Hauf
Notes: |

1.9.0-2.4.1

Created: | 2019-07-12T08:41:23.000Z
Author: | Steffen Hauf
Notes: |

1.8.0-2.4.1

Created: | 2019-07-02T09:29:57.000Z
Author: | Steffen Hauf
Notes: |

1.7.1-2.4.1

Created: | 2019-05-16T11:18:46.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1

Created: | 2019-05-16T09:01:21.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1-dev

Created: | 2019-05-13T09:03:00.000Z
Author: | Steffen Hauf
Notes: |

1.6.0-2.4.1

Created: | 2019-05-02T07:58:11.000Z
Author: | Steffen Hauf
Notes: |

1.5.0-2.4.1-dev

Created: | 2019-04-29T06:41:50.000Z
Author: | Steffen Hauf
Notes: |

1.4.1-2.3.4

Created: | 2019-02-08T12:55:54.000Z
Author: | Steffen Hauf
Notes: |

###### CORR_GAIN_M2

Instance id: | SPB_IRDA_JNGFR/CAL/CORR_GAIN_M2
Host: | exflong02
Alias: | spb-br-sys-cal-2 , sa1-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-02-05T15:37:58.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Karnevskiy, Karnem, Hauf
Latest tag: | 1.11.2-2.7.0
Deployment tag: | 1.11.1-2.7.0
Installed tag: | 1.9.0-2.4.1
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

The installed tag (1.9.0-2.4.1) does not match tags mentioned in the deployment ([‘1.11.1-2.7.0’])!

[add instance documentation]

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Release History
1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.2-2.6.1

Created: | 2019-09-03T14:55:44.000Z
Author: | Steffen Hauf
Notes: |

1.10.1-2.5.0

Created: | 2019-08-29T10:54:11.000Z
Author: | Steffen Hauf
Notes: |

1.10.0-2.5.0

Created: | 2019-08-27T11:42:31.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.5.0

Created: | 2019-07-30T08:24:38.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.4.1-test

Created: | 2019-07-18T09:59:08.000Z
Author: | Steffen Hauf
Notes: |

1.9.1-2.4.1

Created: | 2019-07-18T07:20:27.000Z
Author: | Steffen Hauf
Notes: |

1.9.0-2.4.1

Created: | 2019-07-12T08:41:23.000Z
Author: | Steffen Hauf
Notes: |

1.8.0-2.4.1

Created: | 2019-07-02T09:29:57.000Z
Author: | Steffen Hauf
Notes: |

1.7.1-2.4.1

Created: | 2019-05-16T11:18:46.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1

Created: | 2019-05-16T09:01:21.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1-dev

Created: | 2019-05-13T09:03:00.000Z
Author: | Steffen Hauf
Notes: |

1.6.0-2.4.1

Created: | 2019-05-02T07:58:11.000Z
Author: | Steffen Hauf
Notes: |

1.5.0-2.4.1-dev

Created: | 2019-04-29T06:41:50.000Z
Author: | Steffen Hauf
Notes: |

1.4.1-2.3.4

Created: | 2019-02-08T12:55:54.000Z
Author: | Steffen Hauf
Notes: |

###### CORR_GAIN_M3

Instance id: | SPB_IRDA_JNGFR/CAL/CORR_GAIN_M3
Host: | exflong02
Alias: | spb-br-sys-cal-2 , sa1-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-02-05T15:37:58.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Karnevskiy, Karnem, Hauf
Latest tag: | 1.11.2-2.7.0
Deployment tag: | 1.11.1-2.7.0
Installed tag: | 1.9.0-2.4.1
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

The installed tag (1.9.0-2.4.1) does not match tags mentioned in the deployment ([‘1.11.1-2.7.0’])!

[add instance documentation]

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Release History
1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.2-2.6.1

Created: | 2019-09-03T14:55:44.000Z
Author: | Steffen Hauf
Notes: |

1.10.1-2.5.0

Created: | 2019-08-29T10:54:11.000Z
Author: | Steffen Hauf
Notes: |

1.10.0-2.5.0

Created: | 2019-08-27T11:42:31.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.5.0

Created: | 2019-07-30T08:24:38.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.4.1-test

Created: | 2019-07-18T09:59:08.000Z
Author: | Steffen Hauf
Notes: |

1.9.1-2.4.1

Created: | 2019-07-18T07:20:27.000Z
Author: | Steffen Hauf
Notes: |

1.9.0-2.4.1

Created: | 2019-07-12T08:41:23.000Z
Author: | Steffen Hauf
Notes: |

1.8.0-2.4.1

Created: | 2019-07-02T09:29:57.000Z
Author: | Steffen Hauf
Notes: |

1.7.1-2.4.1

Created: | 2019-05-16T11:18:46.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1

Created: | 2019-05-16T09:01:21.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1-dev

Created: | 2019-05-13T09:03:00.000Z
Author: | Steffen Hauf
Notes: |

1.6.0-2.4.1

Created: | 2019-05-02T07:58:11.000Z
Author: | Steffen Hauf
Notes: |

1.5.0-2.4.1-dev

Created: | 2019-04-29T06:41:50.000Z
Author: | Steffen Hauf
Notes: |

1.4.1-2.3.4

Created: | 2019-02-08T12:55:54.000Z
Author: | Steffen Hauf
Notes: |

###### CORR_GAIN_M6

Instance id: | SPB_IRDA_JNGFR/CAL/CORR_GAIN_M6
Host: | exflong02
Alias: | spb-br-sys-cal-2 , sa1-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-02-05T15:37:58.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Karnevskiy, Karnem, Hauf
Latest tag: | 1.11.2-2.7.0
Deployment tag: | 1.11.1-2.7.0
Installed tag: | 1.9.0-2.4.1
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

The installed tag (1.9.0-2.4.1) does not match tags mentioned in the deployment ([‘1.11.1-2.7.0’])!

[add instance documentation]

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Release History
1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.2-2.6.1

Created: | 2019-09-03T14:55:44.000Z
Author: | Steffen Hauf
Notes: |

1.10.1-2.5.0

Created: | 2019-08-29T10:54:11.000Z
Author: | Steffen Hauf
Notes: |

1.10.0-2.5.0

Created: | 2019-08-27T11:42:31.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.5.0

Created: | 2019-07-30T08:24:38.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.4.1-test

Created: | 2019-07-18T09:59:08.000Z
Author: | Steffen Hauf
Notes: |

1.9.1-2.4.1

Created: | 2019-07-18T07:20:27.000Z
Author: | Steffen Hauf
Notes: |

1.9.0-2.4.1

Created: | 2019-07-12T08:41:23.000Z
Author: | Steffen Hauf
Notes: |

1.8.0-2.4.1

Created: | 2019-07-02T09:29:57.000Z
Author: | Steffen Hauf
Notes: |

1.7.1-2.4.1

Created: | 2019-05-16T11:18:46.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1

Created: | 2019-05-16T09:01:21.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1-dev

Created: | 2019-05-13T09:03:00.000Z
Author: | Steffen Hauf
Notes: |

1.6.0-2.4.1

Created: | 2019-05-02T07:58:11.000Z
Author: | Steffen Hauf
Notes: |

1.5.0-2.4.1-dev

Created: | 2019-04-29T06:41:50.000Z
Author: | Steffen Hauf
Notes: |

1.4.1-2.3.4

Created: | 2019-02-08T12:55:54.000Z
Author: | Steffen Hauf
Notes: |

###### CORR_GAIN_M7

Instance id: | SPB_IRDA_JNGFR/CAL/CORR_GAIN_M7
Host: | exflong02
Alias: | spb-br-sys-cal-2 , sa1-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-02-05T15:37:58.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Karnevskiy, Karnem, Hauf
Latest tag: | 1.11.2-2.7.0
Deployment tag: | 1.11.1-2.7.0
Installed tag: | 1.9.0-2.4.1
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

The installed tag (1.9.0-2.4.1) does not match tags mentioned in the deployment ([‘1.11.1-2.7.0’])!

[add instance documentation]

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Release History
1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.2-2.6.1

Created: | 2019-09-03T14:55:44.000Z
Author: | Steffen Hauf
Notes: |

1.10.1-2.5.0

Created: | 2019-08-29T10:54:11.000Z
Author: | Steffen Hauf
Notes: |

1.10.0-2.5.0

Created: | 2019-08-27T11:42:31.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.5.0

Created: | 2019-07-30T08:24:38.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.4.1-test

Created: | 2019-07-18T09:59:08.000Z
Author: | Steffen Hauf
Notes: |

1.9.1-2.4.1

Created: | 2019-07-18T07:20:27.000Z
Author: | Steffen Hauf
Notes: |

1.9.0-2.4.1

Created: | 2019-07-12T08:41:23.000Z
Author: | Steffen Hauf
Notes: |

1.8.0-2.4.1

Created: | 2019-07-02T09:29:57.000Z
Author: | Steffen Hauf
Notes: |

1.7.1-2.4.1

Created: | 2019-05-16T11:18:46.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1

Created: | 2019-05-16T09:01:21.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1-dev

Created: | 2019-05-13T09:03:00.000Z
Author: | Steffen Hauf
Notes: |

1.6.0-2.4.1

Created: | 2019-05-02T07:58:11.000Z
Author: | Steffen Hauf
Notes: |

1.5.0-2.4.1-dev

Created: | 2019-04-29T06:41:50.000Z
Author: | Steffen Hauf
Notes: |

1.4.1-2.3.4

Created: | 2019-02-08T12:55:54.000Z
Author: | Steffen Hauf
Notes: |

###### CORR_GAIN_M8

Instance id: | SPB_IRDA_JNGFR/CAL/CORR_GAIN_M8
Host: | exflong02
Alias: | spb-br-sys-cal-2 , sa1-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-02-05T15:37:58.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Karnevskiy, Karnem, Hauf
Latest tag: | 1.11.2-2.7.0
Deployment tag: | 1.11.1-2.7.0
Installed tag: | 1.9.0-2.4.1
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

The installed tag (1.9.0-2.4.1) does not match tags mentioned in the deployment ([‘1.11.1-2.7.0’])!

[add instance documentation]

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Release History
1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.2-2.6.1

Created: | 2019-09-03T14:55:44.000Z
Author: | Steffen Hauf
Notes: |

1.10.1-2.5.0

Created: | 2019-08-29T10:54:11.000Z
Author: | Steffen Hauf
Notes: |

1.10.0-2.5.0

Created: | 2019-08-27T11:42:31.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.5.0

Created: | 2019-07-30T08:24:38.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.4.1-test

Created: | 2019-07-18T09:59:08.000Z
Author: | Steffen Hauf
Notes: |

1.9.1-2.4.1

Created: | 2019-07-18T07:20:27.000Z
Author: | Steffen Hauf
Notes: |

1.9.0-2.4.1

Created: | 2019-07-12T08:41:23.000Z
Author: | Steffen Hauf
Notes: |

1.8.0-2.4.1

Created: | 2019-07-02T09:29:57.000Z
Author: | Steffen Hauf
Notes: |

1.7.1-2.4.1

Created: | 2019-05-16T11:18:46.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1

Created: | 2019-05-16T09:01:21.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1-dev

Created: | 2019-05-13T09:03:00.000Z
Author: | Steffen Hauf
Notes: |

1.6.0-2.4.1

Created: | 2019-05-02T07:58:11.000Z
Author: | Steffen Hauf
Notes: |

1.5.0-2.4.1-dev

Created: | 2019-04-29T06:41:50.000Z
Author: | Steffen Hauf
Notes: |

1.4.1-2.3.4

Created: | 2019-02-08T12:55:54.000Z
Author: | Steffen Hauf
Notes: |

###### CORR_OFFSET_M1

Instance id: | SPB_IRDA_JNGFR/CAL/CORR_OFFSET_M1
Host: | exflong02
Alias: | spb-br-sys-cal-2 , sa1-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-02-05T15:37:58.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Karnevskiy, Karnem, Hauf
Latest tag: | 1.11.2-2.7.0
Deployment tag: | 1.11.1-2.7.0
Installed tag: | 1.9.0-2.4.1
Scenes: | preview
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

The installed tag (1.9.0-2.4.1) does not match tags mentioned in the deployment ([‘1.11.1-2.7.0’])!

[add instance documentation]

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Release History
1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.2-2.6.1

Created: | 2019-09-03T14:55:44.000Z
Author: | Steffen Hauf
Notes: |

1.10.1-2.5.0

Created: | 2019-08-29T10:54:11.000Z
Author: | Steffen Hauf
Notes: |

1.10.0-2.5.0

Created: | 2019-08-27T11:42:31.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.5.0

Created: | 2019-07-30T08:24:38.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.4.1-test

Created: | 2019-07-18T09:59:08.000Z
Author: | Steffen Hauf
Notes: |

1.9.1-2.4.1

Created: | 2019-07-18T07:20:27.000Z
Author: | Steffen Hauf
Notes: |

1.9.0-2.4.1

Created: | 2019-07-12T08:41:23.000Z
Author: | Steffen Hauf
Notes: |

1.8.0-2.4.1

Created: | 2019-07-02T09:29:57.000Z
Author: | Steffen Hauf
Notes: |

1.7.1-2.4.1

Created: | 2019-05-16T11:18:46.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1

Created: | 2019-05-16T09:01:21.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1-dev

Created: | 2019-05-13T09:03:00.000Z
Author: | Steffen Hauf
Notes: |

1.6.0-2.4.1

Created: | 2019-05-02T07:58:11.000Z
Author: | Steffen Hauf
Notes: |

1.5.0-2.4.1-dev

Created: | 2019-04-29T06:41:50.000Z
Author: | Steffen Hauf
Notes: |

1.4.1-2.3.4

Created: | 2019-02-08T12:55:54.000Z
Author: | Steffen Hauf
Notes: |

###### CORR_OFFSET_M2

Instance id: | SPB_IRDA_JNGFR/CAL/CORR_OFFSET_M2
Host: | exflong02
Alias: | spb-br-sys-cal-2 , sa1-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-02-05T15:37:58.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Karnevskiy, Karnem, Hauf
Latest tag: | 1.11.2-2.7.0
Deployment tag: | 1.11.1-2.7.0
Installed tag: | 1.9.0-2.4.1
Scenes: | CORRECTED_PREVIEW, dark_sub_prev, dark_sub_prev, preview
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

The installed tag (1.9.0-2.4.1) does not match tags mentioned in the deployment ([‘1.11.1-2.7.0’])!

[add instance documentation]

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Release History
1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.2-2.6.1

Created: | 2019-09-03T14:55:44.000Z
Author: | Steffen Hauf
Notes: |

1.10.1-2.5.0

Created: | 2019-08-29T10:54:11.000Z
Author: | Steffen Hauf
Notes: |

1.10.0-2.5.0

Created: | 2019-08-27T11:42:31.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.5.0

Created: | 2019-07-30T08:24:38.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.4.1-test

Created: | 2019-07-18T09:59:08.000Z
Author: | Steffen Hauf
Notes: |

1.9.1-2.4.1

Created: | 2019-07-18T07:20:27.000Z
Author: | Steffen Hauf
Notes: |

1.9.0-2.4.1

Created: | 2019-07-12T08:41:23.000Z
Author: | Steffen Hauf
Notes: |

1.8.0-2.4.1

Created: | 2019-07-02T09:29:57.000Z
Author: | Steffen Hauf
Notes: |

1.7.1-2.4.1

Created: | 2019-05-16T11:18:46.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1

Created: | 2019-05-16T09:01:21.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1-dev

Created: | 2019-05-13T09:03:00.000Z
Author: | Steffen Hauf
Notes: |

1.6.0-2.4.1

Created: | 2019-05-02T07:58:11.000Z
Author: | Steffen Hauf
Notes: |

1.5.0-2.4.1-dev

Created: | 2019-04-29T06:41:50.000Z
Author: | Steffen Hauf
Notes: |

1.4.1-2.3.4

Created: | 2019-02-08T12:55:54.000Z
Author: | Steffen Hauf
Notes: |

###### CORR_OFFSET_M3

Instance id: | SPB_IRDA_JNGFR/CAL/CORR_OFFSET_M3
Host: | exflong02
Alias: | spb-br-sys-cal-2 , sa1-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-02-05T15:37:58.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Karnevskiy, Karnem, Hauf
Latest tag: | 1.11.2-2.7.0
Deployment tag: | 1.11.1-2.7.0
Installed tag: | 1.9.0-2.4.1
Scenes: | preview
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

The installed tag (1.9.0-2.4.1) does not match tags mentioned in the deployment ([‘1.11.1-2.7.0’])!

[add instance documentation]

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Release History
1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.2-2.6.1

Created: | 2019-09-03T14:55:44.000Z
Author: | Steffen Hauf
Notes: |

1.10.1-2.5.0

Created: | 2019-08-29T10:54:11.000Z
Author: | Steffen Hauf
Notes: |

1.10.0-2.5.0

Created: | 2019-08-27T11:42:31.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.5.0

Created: | 2019-07-30T08:24:38.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.4.1-test

Created: | 2019-07-18T09:59:08.000Z
Author: | Steffen Hauf
Notes: |

1.9.1-2.4.1

Created: | 2019-07-18T07:20:27.000Z
Author: | Steffen Hauf
Notes: |

1.9.0-2.4.1

Created: | 2019-07-12T08:41:23.000Z
Author: | Steffen Hauf
Notes: |

1.8.0-2.4.1

Created: | 2019-07-02T09:29:57.000Z
Author: | Steffen Hauf
Notes: |

1.7.1-2.4.1

Created: | 2019-05-16T11:18:46.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1

Created: | 2019-05-16T09:01:21.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1-dev

Created: | 2019-05-13T09:03:00.000Z
Author: | Steffen Hauf
Notes: |

1.6.0-2.4.1

Created: | 2019-05-02T07:58:11.000Z
Author: | Steffen Hauf
Notes: |

1.5.0-2.4.1-dev

Created: | 2019-04-29T06:41:50.000Z
Author: | Steffen Hauf
Notes: |

1.4.1-2.3.4

Created: | 2019-02-08T12:55:54.000Z
Author: | Steffen Hauf
Notes: |

###### CORR_OFFSET_M6

Instance id: | SPB_IRDA_JNGFR/CAL/CORR_OFFSET_M6
Host: | exflong02
Alias: | spb-br-sys-cal-2 , sa1-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-02-05T15:37:58.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Karnevskiy, Karnem, Hauf
Latest tag: | 1.11.2-2.7.0
Deployment tag: | 1.11.1-2.7.0
Installed tag: | 1.9.0-2.4.1
Scenes: | CORRECTED_PREVIEW, dark_sub_prev, dark_sub_prev, preview
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

The installed tag (1.9.0-2.4.1) does not match tags mentioned in the deployment ([‘1.11.1-2.7.0’])!

[add instance documentation]

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Release History
1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.2-2.6.1

Created: | 2019-09-03T14:55:44.000Z
Author: | Steffen Hauf
Notes: |

1.10.1-2.5.0

Created: | 2019-08-29T10:54:11.000Z
Author: | Steffen Hauf
Notes: |

1.10.0-2.5.0

Created: | 2019-08-27T11:42:31.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.5.0

Created: | 2019-07-30T08:24:38.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.4.1-test

Created: | 2019-07-18T09:59:08.000Z
Author: | Steffen Hauf
Notes: |

1.9.1-2.4.1

Created: | 2019-07-18T07:20:27.000Z
Author: | Steffen Hauf
Notes: |

1.9.0-2.4.1

Created: | 2019-07-12T08:41:23.000Z
Author: | Steffen Hauf
Notes: |

1.8.0-2.4.1

Created: | 2019-07-02T09:29:57.000Z
Author: | Steffen Hauf
Notes: |

1.7.1-2.4.1

Created: | 2019-05-16T11:18:46.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1

Created: | 2019-05-16T09:01:21.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1-dev

Created: | 2019-05-13T09:03:00.000Z
Author: | Steffen Hauf
Notes: |

1.6.0-2.4.1

Created: | 2019-05-02T07:58:11.000Z
Author: | Steffen Hauf
Notes: |

1.5.0-2.4.1-dev

Created: | 2019-04-29T06:41:50.000Z
Author: | Steffen Hauf
Notes: |

1.4.1-2.3.4

Created: | 2019-02-08T12:55:54.000Z
Author: | Steffen Hauf
Notes: |

###### CORR_OFFSET_M7

Instance id: | SPB_IRDA_JNGFR/CAL/CORR_OFFSET_M7
Host: | exflong02
Alias: | spb-br-sys-cal-2 , sa1-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-02-05T15:37:58.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Karnevskiy, Karnem, Hauf
Latest tag: | 1.11.2-2.7.0
Deployment tag: | 1.11.1-2.7.0
Installed tag: | 1.9.0-2.4.1
Scenes: | CORRECTED_PREVIEW, dark_sub_prev, dark_sub_prev, preview
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

The installed tag (1.9.0-2.4.1) does not match tags mentioned in the deployment ([‘1.11.1-2.7.0’])!

[add instance documentation]

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Release History
1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.2-2.6.1

Created: | 2019-09-03T14:55:44.000Z
Author: | Steffen Hauf
Notes: |

1.10.1-2.5.0

Created: | 2019-08-29T10:54:11.000Z
Author: | Steffen Hauf
Notes: |

1.10.0-2.5.0

Created: | 2019-08-27T11:42:31.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.5.0

Created: | 2019-07-30T08:24:38.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.4.1-test

Created: | 2019-07-18T09:59:08.000Z
Author: | Steffen Hauf
Notes: |

1.9.1-2.4.1

Created: | 2019-07-18T07:20:27.000Z
Author: | Steffen Hauf
Notes: |

1.9.0-2.4.1

Created: | 2019-07-12T08:41:23.000Z
Author: | Steffen Hauf
Notes: |

1.8.0-2.4.1

Created: | 2019-07-02T09:29:57.000Z
Author: | Steffen Hauf
Notes: |

1.7.1-2.4.1

Created: | 2019-05-16T11:18:46.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1

Created: | 2019-05-16T09:01:21.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1-dev

Created: | 2019-05-13T09:03:00.000Z
Author: | Steffen Hauf
Notes: |

1.6.0-2.4.1

Created: | 2019-05-02T07:58:11.000Z
Author: | Steffen Hauf
Notes: |

1.5.0-2.4.1-dev

Created: | 2019-04-29T06:41:50.000Z
Author: | Steffen Hauf
Notes: |

1.4.1-2.3.4

Created: | 2019-02-08T12:55:54.000Z
Author: | Steffen Hauf
Notes: |

###### CORR_OFFSET_M8

Instance id: | SPB_IRDA_JNGFR/CAL/CORR_OFFSET_M8
Host: | exflong02
Alias: | spb-br-sys-cal-2 , sa1-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/calPy
Last modified: | 2020-02-05T15:37:58.000+01:00
Created at: | 2017-01-17T10:32:30.000+01:00
Main authors: | Karnevskiy, Karnem, Hauf
Latest tag: | 1.11.2-2.7.0
Deployment tag: | 1.11.1-2.7.0
Installed tag: | 1.9.0-2.4.1
Scenes: | preview
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

The installed tag (1.9.0-2.4.1) does not match tags mentioned in the deployment ([‘1.11.1-2.7.0’])!

[add instance documentation]

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Release History
1.11.2-2.7.0

Created: | 2020-01-28T10:21:28.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.11.1-2.7.0

Created: | 2020-01-07T16:59:49.000Z
Author: | Thomas Michelat
Notes: |

1.11.0-2.7.0

Created: | 2019-12-13T12:08:00.000Z
Author: | Steffen Hauf
Notes: |

1.10.4-2.6.1-hotfix

Created: | 2019-11-12T12:25:58.000Z
Author: | Gabriele Giovanetti
Notes: |

1.10.3-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.1-2.6.1

Created: | 2019-11-04T13:51:07.000Z
Author: | Mikhail Karnevskiy
Notes: |

1.10.2-2.6.1

Created: | 2019-09-03T14:55:44.000Z
Author: | Steffen Hauf
Notes: |

1.10.1-2.5.0

Created: | 2019-08-29T10:54:11.000Z
Author: | Steffen Hauf
Notes: |

1.10.0-2.5.0

Created: | 2019-08-27T11:42:31.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.5.0

Created: | 2019-07-30T08:24:38.000Z
Author: | Steffen Hauf
Notes: |

1.9.2-2.4.1-test

Created: | 2019-07-18T09:59:08.000Z
Author: | Steffen Hauf
Notes: |

1.9.1-2.4.1

Created: | 2019-07-18T07:20:27.000Z
Author: | Steffen Hauf
Notes: |

1.9.0-2.4.1

Created: | 2019-07-12T08:41:23.000Z
Author: | Steffen Hauf
Notes: |

1.8.0-2.4.1

Created: | 2019-07-02T09:29:57.000Z
Author: | Steffen Hauf
Notes: |

1.7.1-2.4.1

Created: | 2019-05-16T11:18:46.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1

Created: | 2019-05-16T09:01:21.000Z
Author: | Steffen Hauf
Notes: |

1.7.0-2.4.1-dev

Created: | 2019-05-13T09:03:00.000Z
Author: | Steffen Hauf
Notes: |

1.6.0-2.4.1

Created: | 2019-05-02T07:58:11.000Z
Author: | Steffen Hauf
Notes: |

1.5.0-2.4.1-dev

Created: | 2019-04-29T06:41:50.000Z
Author: | Steffen Hauf
Notes: |

1.4.1-2.3.4

Created: | 2019-02-08T12:55:54.000Z
Author: | Steffen Hauf
Notes: |

##### DCTRL

[add component documentation]

###### JNGFR_PWR_ON

Instance id: | SPB_IRDA_JNGFR/DCTRL/JNGFR_PWR_ON
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-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

###### JNGFR_CHL_PWR

Instance id: | SPB_IRDA_JNGFR/DCTRL/JNGFR_CHL_PWR
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-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

###### JNGFR_INHBIT

Instance id: | SPB_IRDA_JNGFR/DCTRL/JNGFR_INHBIT
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-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

##### DET

[add component documentation]

###### MODULE_8

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.

###### CONTROL

Instance id: | SPB_IRDA_JNGFR/DET/CONTROL
Host: | exflcon189
Class documentation:
| JungfrauControl
Alias: | spb-rr-sys-con-jungf
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsDetectors
Last modified: | 2020-03-05T16:20:10.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.7.0rc1-2.7.0
Scenes: | TST-JUNGFRAU, CORRECTED_PREVIEW, SPB/SFX_Jungfrau, RawDisplay, preview
Accessible by: | CONTROLS, DA

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

[add instance documentation]

JUNGFRAU DETECTOR

Additional documentation from the detector group can be found here.

Some possible issues are discussed in the Troubleshooting section.

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

Release History
1.7.0rc1-2.7.0

Created: | 2019-12-17T07:56:43.000Z
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T09:57:24.000Z
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T09:57:24.000Z
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T11:35:18.000Z
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T08:35:24.000Z
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T13:30:33.000Z
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T13:15:22.000Z
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T13:28:18.000Z
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

1.5.6-2.6.0

Created: | 2019-09-03T12:57:17.000Z
Author: | Andrea Parenti
Notes: | Write to output channels in the event loop

1.5.5-2.6.0

Created: | 2019-08-16T08:11:36.000Z
Author: | Andrea Parenti
Notes: | Install cmake from DEPENDS

1.5.4rc1-2.5.0

Created: | 2019-07-18T10:47:59.000Z
Author: | Andrea Parenti
Notes: | Write to output channels in the event loop

1.5.3-2.5.0

Created: | 2019-07-18T10:04:37.000Z
Author: | Andrea Parenti
Notes: | For JF in burst mode, use memoryCell to detect new train. Fix Read-the-Docs

1.5.2-2.4.2

Created: | 2019-06-13T11:59:18.000Z
Author: | Andrea Parenti
Notes: | Use UINT8 for gain data

1.5.1-2.4.1

Created: | 2019-05-31T15:10:36.000Z
Author: | Andrea Parenti
Notes: | Don’t verify outdir on control device - it could be on remote computer.

1.5.0-2.4.1

Created: | 2019-05-17T10:09:02.000Z
Author: | Andrea Parenti
Notes: | FEATURE: For Jungfrau save number of memory cell used for image FIX: Reset vectors to default in startAcquisitionCallBack

1.4.2-2.4.0

Created: | 2019-05-03T08:32:24.000Z
Author: | Andrea Parenti
Notes: | FIX - Reset framenumber and timestamp vectors after sending to output

1.4.1-2.4.0-hotfix-rx_udpsocksize

Created: | 2019-04-29T12:27:10.000Z
Author: | xctrl
Notes: |

1.4.0-2.4.0

Created: | 2019-04-12T11:38:23.000Z
Author: | Andrea Parenti
Notes: | configurable Jungfrau storage cells settings

1.3.2-2.3.4

Created: | 2019-02-20T12:38:45.000Z
Author: | Wajid Ehsan
Notes: | Update slsDetectorPackage to 4.0.1 Revert the fix of stop’ command (). The fix is on working on slsDetectorPackage > 4.0

1.2.6-2.3.4

Created: | 2019-02-15T10:39:06.000Z
Author: | Andrea Parenti
Notes: | FIX tcp port was ignored for 2nd (and following) receivers started in the same cppServer

###### MODULE_1

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.

###### MODULE_2

Instance id: | SPB_IRDA_JNGFR/DET/MODULE_2
Host: | exflcon189
Class documentation:
| JungfrauReceiver
Alias: | spb-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.7.0rc1-2.7.0
Scenes: | CORRECTED_PREVIEW, SPB/SFX_Jungfrau, RawDisplay, RawDisplay0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

[add instance documentation]

JUNGFRAU DETECTOR

Additional documentation from the detector group can be found here.

Some possible issues are discussed in the Troubleshooting section.

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

Release History
1.7.0rc1-2.7.0

Created: | 2019-12-17T07:56:43.000Z
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T09:57:24.000Z
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T09:57:24.000Z
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T11:35:18.000Z
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T08:35:24.000Z
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T13:30:33.000Z
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T13:15:22.000Z
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T13:28:18.000Z
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

1.5.6-2.6.0

Created: | 2019-09-03T12:57:17.000Z
Author: | Andrea Parenti
Notes: | Write to output channels in the event loop

1.5.5-2.6.0

Created: | 2019-08-16T08:11:36.000Z
Author: | Andrea Parenti
Notes: | Install cmake from DEPENDS

1.5.4rc1-2.5.0

Created: | 2019-07-18T10:47:59.000Z
Author: | Andrea Parenti
Notes: | Write to output channels in the event loop

1.5.3-2.5.0

Created: | 2019-07-18T10:04:37.000Z
Author: | Andrea Parenti
Notes: | For JF in burst mode, use memoryCell to detect new train. Fix Read-the-Docs

1.5.2-2.4.2

Created: | 2019-06-13T11:59:18.000Z
Author: | Andrea Parenti
Notes: | Use UINT8 for gain data

1.5.1-2.4.1

Created: | 2019-05-31T15:10:36.000Z
Author: | Andrea Parenti
Notes: | Don’t verify outdir on control device - it could be on remote computer.

1.5.0-2.4.1

Created: | 2019-05-17T10:09:02.000Z
Author: | Andrea Parenti
Notes: | FEATURE: For Jungfrau save number of memory cell used for image FIX: Reset vectors to default in startAcquisitionCallBack

1.4.2-2.4.0

Created: | 2019-05-03T08:32:24.000Z
Author: | Andrea Parenti
Notes: | FIX - Reset framenumber and timestamp vectors after sending to output

1.4.1-2.4.0-hotfix-rx_udpsocksize

Created: | 2019-04-29T12:27:10.000Z
Author: | xctrl
Notes: |

1.4.0-2.4.0

Created: | 2019-04-12T11:38:23.000Z
Author: | Andrea Parenti
Notes: | configurable Jungfrau storage cells settings

1.3.2-2.3.4

Created: | 2019-02-20T12:38:45.000Z
Author: | Wajid Ehsan
Notes: | Update slsDetectorPackage to 4.0.1 Revert the fix of stop’ command (). The fix is on working on slsDetectorPackage > 4.0

1.2.6-2.3.4

Created: | 2019-02-15T10:39:06.000Z
Author: | Andrea Parenti
Notes: | FIX tcp port was ignored for 2nd (and following) receivers started in the same cppServer

###### MODULE_3

Instance id: | SPB_IRDA_JNGFR/DET/MODULE_3
Host: | exflcon189
Class documentation:
| JungfrauReceiver
Alias: | spb-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.7.0rc1-2.7.0
Scenes: | SPB/SFX_Jungfrau, RawDisplay, RawDisplay0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

[add instance documentation]

JUNGFRAU DETECTOR

Additional documentation from the detector group can be found here.

Some possible issues are discussed in the Troubleshooting section.

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

Release History
1.7.0rc1-2.7.0

Created: | 2019-12-17T07:56:43.000Z
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T09:57:24.000Z
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T09:57:24.000Z
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T11:35:18.000Z
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T08:35:24.000Z
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T13:30:33.000Z
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T13:15:22.000Z
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T13:28:18.000Z
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

1.5.6-2.6.0

Created: | 2019-09-03T12:57:17.000Z
Author: | Andrea Parenti
Notes: | Write to output channels in the event loop

1.5.5-2.6.0

Created: | 2019-08-16T08:11:36.000Z
Author: | Andrea Parenti
Notes: | Install cmake from DEPENDS

1.5.4rc1-2.5.0

Created: | 2019-07-18T10:47:59.000Z
Author: | Andrea Parenti
Notes: | Write to output channels in the event loop

1.5.3-2.5.0

Created: | 2019-07-18T10:04:37.000Z
Author: | Andrea Parenti
Notes: | For JF in burst mode, use memoryCell to detect new train. Fix Read-the-Docs

1.5.2-2.4.2

Created: | 2019-06-13T11:59:18.000Z
Author: | Andrea Parenti
Notes: | Use UINT8 for gain data

1.5.1-2.4.1

Created: | 2019-05-31T15:10:36.000Z
Author: | Andrea Parenti
Notes: | Don’t verify outdir on control device - it could be on remote computer.

1.5.0-2.4.1

Created: | 2019-05-17T10:09:02.000Z
Author: | Andrea Parenti
Notes: | FEATURE: For Jungfrau save number of memory cell used for image FIX: Reset vectors to default in startAcquisitionCallBack

1.4.2-2.4.0

Created: | 2019-05-03T08:32:24.000Z
Author: | Andrea Parenti
Notes: | FIX - Reset framenumber and timestamp vectors after sending to output

1.4.1-2.4.0-hotfix-rx_udpsocksize

Created: | 2019-04-29T12:27:10.000Z
Author: | xctrl
Notes: |

1.4.0-2.4.0

Created: | 2019-04-12T11:38:23.000Z
Author: | Andrea Parenti
Notes: | configurable Jungfrau storage cells settings

1.3.2-2.3.4

Created: | 2019-02-20T12:38:45.000Z
Author: | Wajid Ehsan
Notes: | Update slsDetectorPackage to 4.0.1 Revert the fix of stop’ command (). The fix is on working on slsDetectorPackage > 4.0

1.2.6-2.3.4

Created: | 2019-02-15T10:39:06.000Z
Author: | Andrea Parenti
Notes: | FIX tcp port was ignored for 2nd (and following) receivers started in the same cppServer

###### MODULE_6

Instance id: | SPB_IRDA_JNGFR/DET/MODULE_6
Host: | exflcon189
Class documentation:
| JungfrauReceiver
Alias: | spb-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.7.0rc1-2.7.0
Scenes: | CORRECTED_PREVIEW, SPB/SFX_Jungfrau, RawDisplay, RawDisplay0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

[add instance documentation]

JUNGFRAU DETECTOR

Additional documentation from the detector group can be found here.

Some possible issues are discussed in the Troubleshooting section.

SLS DETECTORS

The documentation of the Karabo device for SLS detectors (Gotthard, Jungfrau) can be found here

In particular, the setup is described in this Section, and the troubleshooting in this other.

Release History
1.7.0rc1-2.7.0

Created: | 2019-12-17T07:56:43.000Z
Author: | Andrea Parenti
Notes: | Use trainId from frame metadata - whenever available

1.6.1-2.6.5

Created: | 2019-12-09T09:57:24.000Z
Author: | Andrea Parenti
Notes: | Same as 1.5.1-2.6.5, which was wrongly numbered.

1.5.1-2.6.5

Created: | 2019-12-09T09:57:24.000Z
Author: | Andrea Parenti
Notes: | FIX m_numberOfModules initial value

1.6.0-2.6.4

Created: | 2019-11-18T11:35:18.000Z
Author: | Andrea Parenti
Notes: | Set additional read-out timeout for JF

1.5.10-2.6.2

Created: | 2019-10-18T08:35:24.000Z
Author: | Andrea Parenti
Notes: | Free shared memory in destructor

1.5.9-2.6.2

Created: | 2019-09-30T13:30:33.000Z
Author: | Andrea Parenti
Notes: |

1.5.8-2.6.2

Created: | 2019-09-27T13:15:22.000Z
Author: | Andrea Parenti
Notes: | FIX detector reconfiguration (bug introduced in 1.5.7-2.6.1) Add deployment, configuration and troubleshooting docs

1.5.7-2.6.1

Created: | 2019-09-17T13:28:18.000Z
Author: | Andrea Parenti
Notes: | FIX update state to ON only after configuration is done

1.5.6-2.6.0

Created: | 2019-09-03T12:57:17.000Z
Author: | Andrea Parenti
Notes: | Write to output channels in the event loop

1.5.5-2.6.0

Created: | 2019-08-16T08:11:36.000Z
Author: | Andrea Parenti
Notes: | Install cmake from DEPENDS

1.5.4rc1-2.5.0

Created: | 2019-07-18T10:47:59.000Z
Author: | Andrea Parenti
Notes: | Write to output channels in the event loop

1.5.3-2.5.0

Created: | 2019-07-18T10:04:37.000Z
Author: | Andrea Parenti
Notes: | For JF in burst mode, use memoryCell to detect new train. Fix Read-the-Docs

1.5.2-2.4.2

Created: | 2019-06-13T11:59:18.000Z
Author: | Andrea Parenti
Notes: | Use UINT8 for gain data

1.5.1-2.4.1

Created: | 2019-05-31T15:10:36.000Z
Author: | Andrea Parenti
Notes: | Don’t verify outdir on control device - it could be on remote computer.

1.5.0-2.4.1

Created: | 2019-05-17T10:09:02.000Z
Author: | Andrea Parenti
Notes: | FEATURE: For Jungfrau save number of memory cell used for image FIX: Reset vectors to default in startAcquisitionCallBack

1.4.2-2.4.0

Created: | 2019-05-03T08:32:24.000Z
Author: | Andrea Parenti
Notes: | FIX - Reset framenumber and timestamp vectors after sending to output

1.4.1-2.4.0-hotfix-rx_udpsocksize

Created: | 2019-04-29T12:27:10.000Z
Author: | xctrl
Notes: |

1.4.0-2.4.0

Created: | 2019-04-12T11:38:23.000Z
Author: | Andrea Parenti
Notes: | configurable Jungfrau storage cells settings

1.3.2-2.3.4

Created: | 2019-02-20T12:38:45.000Z
Author: | Wajid Ehsan
Notes: | Update slsDetectorPackage to 4.0.1 Revert the fix of stop’ command (). The fix is on working on slsDetectorPackage > 4.0

1.2.6-2.3.4

Created: | 2019-02-15T10:39:06.000Z
Author: | Andrea Parenti
Notes: | FIX tcp port was ignored for 2nd (and following) receivers started in the same cppServer

###### MODULE_7

Instance id: | SPB_IRDA_JNGFR/DET/MODULE_7
Host: | exflcon189
Class documentation:
| JungfrauReceiver
Alias: | spb-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.7.0rc1-2.7.0
Scenes: | CORRECTED_PREVIEW, SPB/SFX_Jungfrau, RawDisplay, RawDisplay0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

[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

##### ENC

[add component documentation]

###### Z

Instance id: | SPB_IRDA_JNGFR/ENC/Z
Class id: | BeckhoffEncoder
Host: | exflcon32n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-08-07T08:53:54.000+02:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Hauf, Giovanetti, Silenzi
Latest tag: | 4.3.18-2.9.6
Deployment tag: | 4.3.18-2.9.6
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- value:
    Encoder read value
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- offset:
    Linear offset for analog value.
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.

Release History
4.3.18-2.9.6

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: |

4.3.18-2.9.4

Created: | 2020-08-03T11:13:23.000Z
Author: | Steffen Hauf
Notes: | To have binaries for 2.9.4

4.3.17-2.9.6

Created: | 2020-08-03T09:22:48.000Z
Author: | Gabriele Giovanetti
Notes: | MC2 small motions and XML error codes

4.3.16-2.9.1

Created: | 2020-07-03T13:12:05.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.16-2.9.1-test@SPB-01

Created: | 2020-07-01T04:54:23.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.17-2.9.1-test-small-motion

Created: | 2020-06-30T13:56:17.000Z
Author: | Gabriele Giovanetti
Notes: | Test tag

4.3.16-2.9.1-test@SPB

Created: | 2020-06-26T05:52:31.000Z
Author: | Steffen Hauf
Notes: |

4.3.15-2.9.1

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | Make sure a binary for 2.9.1 exists

4.3.15-2.9.0

Created: | 2020-05-14T11:24:40.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Trigger 1 problem FEAT: Agilent Ion Pump has automatic log scale

4.3.14-2.8.1

Created: | 2020-04-03T08:08:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1

Created: | 2020-03-26T06:01:43.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.13-2.8.1-test

Created: | 2020-03-25T15:10:32.000Z
Author: | Gabriele Giovanetti
Notes: |

4.3.12-2.8.1

Created: | 2020-03-25T08:47:47.000Z
Author: | Gabriele Giovanetti
Notes: | Simulation build config Noisy state updates handling.

4.3.11-2.7.0

Created: | 2019-12-18T15:04:13.000Z
Author: | Gabriele Giovanetti
Notes: | BeckhoffManifolValve device class available

4.3.10-2.6.1

Created: | 2019-09-04T11:15:12.000Z
Author: | Alessandro Silenzi
Notes: | SIM/GUI: adapting MC2 implementation. See merge request karaboDevices/Beckhoff!283

4.3.9-2.6.1

Created: | 2019-08-30T16:50:57.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Schema parsing follow up FIX: Inficon setpoint property types FIX: slowing down instantiation FIX: Error decoding at startup FIX: no epsilon regulation after CSendAll FIX: request new configuration on failure

4.3.8-2.6.1

Created: | 2019-08-26T20:25:54.000Z
Author: | Valerii Bondar
Notes: | Mangling schema elements that have spaces from the PLC

4.3.7-2.6.0

Created: | 2019-08-15T15:46:37.000Z
Author: | Alessandro Silenzi
Notes: |

4.3.6-2.5.0

Created: | 2019-08-07T11:12:16.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

4.3.5-2.5.0

Created: | 2019-07-24T15:35:58.000Z
Author: | Alessandro Silenzi
Notes: | LED is not instantiated as a digital output

###### X1

Instance id: | SPB_IRDA_JNGFR/ENC/X1
Class id: | BeckhoffEncoder
Host: | exflcon32n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- value:
    Encoder read value
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- offset:
    Linear offset for analog value.
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.

Release History
4.4.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: |

###### X2

Instance id: | SPB_IRDA_JNGFR/ENC/X2
Class id: | BeckhoffEncoder
Host: | exflcon32n0
Class documentation:
| BeckhoffEncoder
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- version:
    Version of this Karabo device.
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- enableLatchInternal:
    Enables the storage of the value of the scale latched to the internal reference
- enableLatchExternal:
    Enables the storage of the value of the scale latched to the external reference
- value:
    Encoder read value
- adcValue:
    The integer value read out by the encoder
- factor:
    Calibration factor to target unit
- offset:
    Linear offset for analog value.
- setCounter16:
    Set value for 16 bit encoder.
- setCounter32:
    Set value for 32 bit encoder.
- ssiCoding:
    Binary coding or grey coding. False - Binary; True - Grey
- ssiFrameType:
    Length of the SSI data frame.
- ssiFrameSize:
    Not documented.
- ssiDataLength:
    Not documented.

Release History
4.4.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: |

##### MDL

[add component documentation]

###### MONITOR

Instance id: | SPB_IRDA_JNGFR/MDL/MONITOR
Host: | exflcon45n0
Alias: | spb-rr-sys-con-spc
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/slsMonitor
Last modified: | 2019-04-12T14:55:37.000+02:00
Created at: | 2019-04-09T13:28:05.000+02:00
Main authors: | Giovanetti
Latest tag: | 0.0.0-2.4.0
Deployment tag: | 0.0.0-2.4.0
Installed tag: | 0.0.0-2.4.0
Scenes: | Jungfrau_Temperature
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
0.0.0-2.4.0

Created: | 2019-04-12T13:40:22.000Z
Author: | Gabriele Giovanetti
Notes: |

###### CONFIG_TEST

Instance id: | SPB_IRDA_JNGFR/MDL/CONFIG_TEST
Host: | exflcon45n0
Alias: | spb-rr-sys-con-spc
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/JungfrauMiddlelayer
Last modified: | 2020-01-17T10:35:25.000+01:00
Created at: | 2019-06-26T15:46:48.000+02:00
Main authors: | Hauf, Ehsan, Ahmed
Latest tag: | 1.1.8-2.6.1
Deployment tag: | 1.1.8-2.6.1
Installed tag: | 1.1.8-2.6.1
Scenes: | SPB/SFX_Jungfrau
Accessible by: | CONTROLS, DA

[add instance documentation]

Release History
1.1.8-2.6.1

Created: | 2019-12-17T15:52:43.000Z
Author: | Wajid Ehsan
Notes: | Make run controller timeouts and sleeps configurable

1.1.7-2.6.1-double-hotfix@SPB

Created: | 2019-11-15T08:18:27.000Z
Author: | Steffen Hauf
Notes: |

1.1.7-2.6.1

Created: | 2019-11-12T13:26:07.000Z
Author: | Steffen Hauf
Notes: |

1.1.6-2.6.0

Created: | 2019-11-05T13:27:35.000Z
Author: | Gabriele Giovanetti
Notes: |

1.1.5-2.6.0

Created: | 2019-11-05T13:22:50.000Z
Author: | Karim Ahmed
Notes: |

1.1.4-2.6.0-hotfix@SPB

Created: | 2019-10-30T15:02:41.000Z
Author: | Gabriele Giovanetti
Notes: |

1.1.3-2.6.0

Created: | 2019-09-19T08:53:07.000Z
Author: | Karim Ahmed
Notes: |

1.1.2-2.6.0-test

Created: | 2019-09-13T08:29:22.000Z
Author: | Karim Ahmed
Notes: |

1.1.1-2.6.0-test

Created: | 2019-09-03T13:26:52.000Z
Author: | Karim Ahmed
Notes: |

1.1.0-2.5.0

Created: | 2019-07-31T09:43:32.000Z
Author: | xctrl
Notes: |

1.0.0-2.5.0

Created: | 2019-07-30T08:33:46.000Z
Author: | Steffen Hauf
Notes: |

##### MOTOR

[add component documentation]

###### Z

###### X1

###### X2

##### SWITCH

[add component documentation]

###### JNGFR_PWR_PWR_OK

Instance id: | SPB_IRDA_JNGFR/SWITCH/JNGFR_PWR_PWR_OK
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

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

###### JNGFR_CHL_SYS_FAULT

Instance id: | SPB_IRDA_JNGFR/SWITCH/JNGFR_CHL_SYS_FAULT
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

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

###### JNGFR_CHL_TEMP_ALARM

Instance id: | SPB_IRDA_JNGFR/SWITCH/JNGFR_CHL_TEMP_ALARM
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

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

###### JNGFR_PWR_AC_OK

Instance id: | SPB_IRDA_JNGFR/SWITCH/JNGFR_PWR_AC_OK
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

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

###### JNGFR_PWR_ENABLE

Instance id: | SPB_IRDA_JNGFR/SWITCH/JNGFR_PWR_ENABLE
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

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

###### JNGFR_PWR_OTW

Instance id: | SPB_IRDA_JNGFR/SWITCH/JNGFR_PWR_OTW
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

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

##### TSENS

[add component documentation]

###### H2M_T_OUT

Instance id: | SPB_IRDA_JNGFR/TSENS/H2M_T_OUT
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### H1M1_T_ASIC

Instance id: | SPB_IRDA_JNGFR/TSENS/H1M1_T_ASIC
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### H1M1_T_PCB

Instance id: | SPB_IRDA_JNGFR/TSENS/H1M1_T_PCB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### H1M2_T_ASIC

Instance id: | SPB_IRDA_JNGFR/TSENS/H1M2_T_ASIC
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### H1M2_T_PCB

Instance id: | SPB_IRDA_JNGFR/TSENS/H1M2_T_PCB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### H1M3_T_ASIC

Instance id: | SPB_IRDA_JNGFR/TSENS/H1M3_T_ASIC
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### H1M3_T_PCB

Instance id: | SPB_IRDA_JNGFR/TSENS/H1M3_T_PCB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### H1M4_T_ASIC

Instance id: | SPB_IRDA_JNGFR/TSENS/H1M4_T_ASIC
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### H1M4_T_PCB

Instance id: | SPB_IRDA_JNGFR/TSENS/H1M4_T_PCB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### H1M_T_IN

Instance id: | SPB_IRDA_JNGFR/TSENS/H1M_T_IN
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### H1M_T_OUT

Instance id: | SPB_IRDA_JNGFR/TSENS/H1M_T_OUT
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### H2M1_T_ASIC

Instance id: | SPB_IRDA_JNGFR/TSENS/H2M1_T_ASIC
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### H2M1_T_PCB

Instance id: | SPB_IRDA_JNGFR/TSENS/H2M1_T_PCB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### H2M2_T_ASIC

Instance id: | SPB_IRDA_JNGFR/TSENS/H2M2_T_ASIC
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### H2M2_T_PCB

Instance id: | SPB_IRDA_JNGFR/TSENS/H2M2_T_PCB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### H2M3_T_ASIC

Instance id: | SPB_IRDA_JNGFR/TSENS/H2M3_T_ASIC
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### H2M3_T_PCB

Instance id: | SPB_IRDA_JNGFR/TSENS/H2M3_T_PCB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### H2M4_T_ASIC

Instance id: | SPB_IRDA_JNGFR/TSENS/H2M4_T_ASIC
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### H2M4_T_PCB

Instance id: | SPB_IRDA_JNGFR/TSENS/H2M4_T_PCB
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### H2M_T_IN

Instance id: | SPB_IRDA_JNGFR/TSENS/H2M_T_IN
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-13
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-13
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

#### JF4M

[add component documentation]

##### DET

[add component documentation]

###### CONTROL

Instance id: | SPB_IRDA_JF4M/DET/CONTROL
Class id: | JungfrauControl
Host: | spb-rr-sys-con-jungf-1
Class documentation:
| JungfrauControl
Alias: | spb-rr-sys-con-jungf-1
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: | SPB/SFX_Jungfrau, preview, RAW_PREVIEW, SPB/SFX_Jungfrau_DOC, SPB-SFX_Jungfrau, SPB-SFX_Jungfrau_DOC
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!

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-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

###### JNGFR01

Instance id: | SPB_IRDA_JF4M/DET/JNGFR01
Class id: | JungfrauReceiver
Host: | spb-rr-sys-con-jungf-2
Class documentation:
| JungfrauReceiver
Alias: | spb-rr-sys-con-jungf-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: | SPB/SFX_Jungfrau, preview, RAW_PREVIEW, CAL_PIPELINE_OVERVIEW, SPB/SFX_Jungfrau_DOC, SPB-SFX_Jungfrau, SPB-SFX_Jungfrau_DOC
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!

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-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

###### JNGFR02

Instance id: | SPB_IRDA_JF4M/DET/JNGFR02
Class id: | JungfrauReceiver
Host: | spb-rr-sys-con-jungf-1
Class documentation:
| JungfrauReceiver
Alias: | spb-rr-sys-con-jungf-1
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: | SPB/SFX_Jungfrau, preview, RAW_PREVIEW, singleJfmod, SPB/SFX_Jungfrau_DOC, SPB-SFX_Jungfrau, SPB-SFX_Jungfrau_DOC
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!

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-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

###### JNGFR03

Instance id: | SPB_IRDA_JF4M/DET/JNGFR03
Class id: | JungfrauReceiver
Host: | spb-rr-sys-con-jungf-1
Class documentation:
| JungfrauReceiver
Alias: | spb-rr-sys-con-jungf-1
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: | SPB/SFX_Jungfrau, preview, RAW_PREVIEW, SPB/SFX_Jungfrau_DOC, SPB-SFX_Jungfrau, SPB-SFX_Jungfrau_DOC
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!

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-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

###### JNGFR06

Instance id: | SPB_IRDA_JF4M/DET/JNGFR06
Class id: | JungfrauReceiver
Host: | spb-rr-sys-con-jungf-1
Class documentation:
| JungfrauReceiver
Alias: | spb-rr-sys-con-jungf-1
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: | SPB/SFX_Jungfrau, preview, RAW_PREVIEW, SPB/SFX_Jungfrau_DOC, SPB-SFX_Jungfrau, SPB-SFX_Jungfrau_DOC
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!

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-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

###### JNGFR07

Instance id: | SPB_IRDA_JF4M/DET/JNGFR07
Class id: | JungfrauReceiver
Host: | spb-rr-sys-con-jungf-1
Class documentation:
| JungfrauReceiver
Alias: | spb-rr-sys-con-jungf-1
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: | SPB/SFX_Jungfrau, preview, RAW_PREVIEW, SPB/SFX_Jungfrau_DOC, SPB-SFX_Jungfrau, SPB-SFX_Jungfrau_DOC
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!

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-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

###### JNGFR08

Instance id: | SPB_IRDA_JF4M/DET/JNGFR08
Class id: | JungfrauReceiver
Host: | spb-rr-sys-con-jungf-2
Class documentation:
| JungfrauReceiver
Alias: | spb-rr-sys-con-jungf-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: | SPB/SFX_Jungfrau, preview, RAW_PREVIEW, SPB/SFX_Jungfrau_DOC, SPB-SFX_Jungfrau, SPB-SFX_Jungfrau_DOC
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!

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-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

###### JNGFR04

Instance id: | SPB_IRDA_JF4M/DET/JNGFR04
Class id: | JungfrauReceiver
Host: | spb-rr-sys-con-jungf-3
Class documentation:
| JungfrauReceiver
Alias: | spb-rr-sys-con-jungf-3
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: | SPB/SFX_Jungfrau, preview, RAW_PREVIEW, SPB/SFX_Jungfrau_DOC, SPB-SFX_Jungfrau, SPB-SFX_Jungfrau_DOC
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!

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-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

###### JNGFR05

Instance id: | SPB_IRDA_JF4M/DET/JNGFR05
Class id: | JungfrauReceiver
Host: | spb-rr-sys-con-jungf-3
Class documentation:
| JungfrauReceiver
Alias: | spb-rr-sys-con-jungf-3
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: | SPB/SFX_Jungfrau, preview, RAW_PREVIEW, SPB/SFX_Jungfrau_DOC, SPB-SFX_Jungfrau, SPB-SFX_Jungfrau_DOC
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!

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-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

###### CONTROL-1-TEST

Instance id: | SPB_IRDA_JF4M/DET/CONTROL-1-TEST
Class id: | JungfrauControl
Host: | spb-rr-sys-con-jungf-1
Class documentation:
| JungfrauControl
Alias: | spb-rr-sys-con-jungf-1
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
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!

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-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

###### CONTROL-4-5-TEST

Instance id: | SPB_IRDA_JF4M/DET/CONTROL-4-5-TEST
Class id: | JungfrauControl
Host: | spb-rr-sys-con-jungf-1
Class documentation:
| JungfrauControl
Alias: | spb-rr-sys-con-jungf-1
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
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!

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-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

###### CONTROL-4-TEST

Instance id: | SPB_IRDA_JF4M/DET/CONTROL-4-TEST
Class id: | JungfrauControl
Host: | spb-rr-sys-con-jungf-1
Class documentation:
| JungfrauControl
Alias: | spb-rr-sys-con-jungf-1
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
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!

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-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

###### CONTROL-5-TEST

Instance id: | SPB_IRDA_JF4M/DET/CONTROL-5-TEST
Class id: | JungfrauControl
Host: | spb-rr-sys-con-jungf-1
Class documentation:
| JungfrauControl
Alias: | spb-rr-sys-con-jungf-1
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
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!

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-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

###### CONTROL-ALL8-TEST

Instance id: | SPB_IRDA_JF4M/DET/CONTROL-ALL8-TEST
Class id: | JungfrauControl
Host: | spb-rr-sys-con-jungf-1
Class documentation:
| JungfrauControl
Alias: | spb-rr-sys-con-jungf-1
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
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!

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-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

##### MDL

[add component documentation]

###### CONFIG_TEST

Instance id: | SPB_IRDA_JF4M/MDL/CONFIG_TEST
Class id: | JungfrauConfig
Host: | spb-rr-sys-con-spc
Alias: | spb-rr-sys-con-spc
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/JungfrauMiddlelayer
Last modified: | 2021-02-26T13:56:39.000+01:00
Created at: | 2019-06-26T15:46:48.000+02:00
Main authors: | Parenti, Hauf, Xctrl
Latest tag: | 1.2.2-2.10.0
Deployment tag: | 1.2.2-2.10.0
Scenes: | SPB/SFX_Jungfrau, RAW_PREVIEW, SPB/SFX_Jungfrau_DOC, SPB-SFX_Jungfrau, SPB-SFX_Jungfrau_DOC
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock 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.2-2.10.0

Created: | 2020-12-02T09:16:46.000Z
Author: | Andrea Parenti
Notes: | Summary: update daqController to 1.4.4-2.10.0

1.2.1-2.10.0

Created: | 2020-11-23T13:10:42.000Z
Author: | Andrea Parenti
Notes: | Summary: add version info

1.2.0-2.8.0

Created: | 2020-11-19T13:24:50.000Z
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-21T17:14:42.000Z
Author: | Istvan Mohacsi
Notes: | Preparing the dark characterization device

1.2.0-2.8.0-test

Created: | 2020-04-14T08:50:05.000Z
Author: | Istvan Mohacsi
Notes: |

1.1.8-2.6.1

Created: | 2019-12-17T15:52:43.000Z
Author: | Wajid Ehsan
Notes: | Make run controller timeouts and sleeps configurable

1.1.7-2.6.1-double-hotfix@SPB

Created: | 2019-11-15T08:18:27.000Z
Author: | Steffen Hauf
Notes: |

1.1.7-2.6.1

Created: | 2019-11-12T13:26:07.000Z
Author: | Steffen Hauf
Notes: |

1.1.6-2.6.0

Created: | 2019-11-05T13:27:35.000Z
Author: | Gabriele Giovanetti
Notes: |

1.1.5-2.6.0

Created: | 2019-11-05T13:22:50.000Z
Author: | Karim Ahmed
Notes: |

1.1.4-2.6.0-hotfix@SPB

Created: | 2019-10-30T15:02:41.000Z
Author: | Gabriele Giovanetti
Notes: |

1.1.3-2.6.0

Created: | 2019-09-19T08:53:07.000Z
Author: | Karim Ahmed
Notes: |

1.1.2-2.6.0-test

Created: | 2019-09-13T08:29:22.000Z
Author: | Karim Ahmed
Notes: |

1.1.1-2.6.0-test

Created: | 2019-09-03T13:26:52.000Z
Author: | Karim Ahmed
Notes: |

1.1.0-2.5.0

Created: | 2019-07-31T09:43:32.000Z
Author: | xctrl
Notes: |

1.0.0-2.5.0

Created: | 2019-07-30T08:33:46.000Z
Author: | Steffen Hauf
Notes: |

###### MONITOR

###### DARK_CHAR

Instance id: | SPB_IRDA_JF4M/MDL/DARK_CHAR
Class id: | JungfrauDarkChar
Host: | spb-rr-sys-con-spc
Alias: | spb-rr-sys-con-spc
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/JungfrauMiddlelayer
Last modified: | 2021-02-26T13:56:39.000+01:00
Created at: | 2019-06-26T15:46:48.000+02:00
Main authors: | Parenti, Hauf, Xctrl
Latest tag: | 1.2.2-2.10.0
Deployment tag: | 1.2.2-2.10.0
Scenes: | SPB/SFX_Jungfrau, tst-dark, SPB-SFX_Jungfrau
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock 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.2-2.10.0

Created: | 2020-12-02T09:16:46.000Z
Author: | Andrea Parenti
Notes: | Summary: update daqController to 1.4.4-2.10.0

1.2.1-2.10.0

Created: | 2020-11-23T13:10:42.000Z
Author: | Andrea Parenti
Notes: | Summary: add version info

1.2.0-2.8.0

Created: | 2020-11-19T13:24:50.000Z
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-21T17:14:42.000Z
Author: | Istvan Mohacsi
Notes: | Preparing the dark characterization device

1.2.0-2.8.0-test

Created: | 2020-04-14T08:50:05.000Z
Author: | Istvan Mohacsi
Notes: |

1.1.8-2.6.1

Created: | 2019-12-17T15:52:43.000Z
Author: | Wajid Ehsan
Notes: | Make run controller timeouts and sleeps configurable

1.1.7-2.6.1-double-hotfix@SPB

Created: | 2019-11-15T08:18:27.000Z
Author: | Steffen Hauf
Notes: |

1.1.7-2.6.1

Created: | 2019-11-12T13:26:07.000Z
Author: | Steffen Hauf
Notes: |

1.1.6-2.6.0

Created: | 2019-11-05T13:27:35.000Z
Author: | Gabriele Giovanetti
Notes: |

1.1.5-2.6.0

Created: | 2019-11-05T13:22:50.000Z
Author: | Karim Ahmed
Notes: |

1.1.4-2.6.0-hotfix@SPB

Created: | 2019-10-30T15:02:41.000Z
Author: | Gabriele Giovanetti
Notes: |

1.1.3-2.6.0

Created: | 2019-09-19T08:53:07.000Z
Author: | Karim Ahmed
Notes: |

1.1.2-2.6.0-test

Created: | 2019-09-13T08:29:22.000Z
Author: | Karim Ahmed
Notes: |

1.1.1-2.6.0-test

Created: | 2019-09-03T13:26:52.000Z
Author: | Karim Ahmed
Notes: |

1.1.0-2.5.0

Created: | 2019-07-31T09:43:32.000Z
Author: | xctrl
Notes: |

1.0.0-2.5.0

Created: | 2019-07-30T08:33:46.000Z
Author: | Steffen Hauf
Notes: |

###### POWER

###### DAQ_CONTROLLER

Instance id: | SPB_IRDA_JF4M/MDL/DAQ_CONTROLLER
Class id: | DaqController
Host: | spb-rr-sys-con-spc
Alias: | spb-rr-sys-con-spc
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/daqController
Last modified: | 2021-06-09T16:39:42.000+02:00
Created at: | 2019-03-11T15:44:30.000+01:00
Main authors: | Haufs, Parenti, Cas
Latest tag: | 1.4.4-2.10.0-hotfix@SPB
Deployment tag: | 1.4.4-2.10.0-hotfix@SPB
Scenes: | tst-dark
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- daqTimeout:
    The configuration timeout to wait for DAQ state changes
- runController:
    The deviceId of the RunController to use, starts and stops daq.
- autoFill:
    Automatically fill the list of DataAggregators from the RunController. Uncheck to manually define the relevant DataAggregators.
- dataAggregators:
    The deviceId to the DataAggregators on the current RunController. Tick autoFill to fill automatically.
- runConfigurator:
    The deviceId of the current RunConfigurator. It is filled automatically.
- start:
    Start DAQ with the previously applied configuration
- stop:
    Stop the current run.
- setup:
    Configure the DAQ before acquisition and check device states.
- toggle:
    Pause or resume a running acquisition.

Release History
1.4.4-2.10.0-hotfix@SPB

Created: | 2021-02-24T16:55:09.000Z
Author: | Gabriele Giovanetti
Notes: | For use with JungfrauDarkChar device

1.4.4-2.10.0

Created: | 2020-11-24T21:11:03.000Z
Author: | Wajid Ehsan
Notes: | Version Update Info

1.4.3-2.9.0

Created: | 2020-08-21T08:53:55.000Z
Author: | Andrea Parenti
Notes: | Summary: Internal refactor needed by AgipdDaqController derived class

1.4.2-2.9.0

Created: | 2020-08-20T12:48:22.000Z
Author: | Andrea Parenti
Notes: | Summary: Split-off autoFill from onInitialization

1.4.1-2.9.0

Created: | 2020-07-15T11:27:28.000Z
Author: | Istvan Mohacsi
Notes: |

1.4.0-2.9.0

Created: | 2020-06-04T14:30:28.000Z
Author: | Istvan Mohacsi
Notes: | Added device scene.

1.3.1-2.8.0

Created: | 2020-05-14T10:43:24.000Z
Author: | Istvan Mohacsi
Notes: |

1.30-2.8.0-test

Created: | 2020-04-28T09:20:59.000Z
Author: | Istvan Mohacsi
Notes: | The pause / resume feature was only tested on unofficial installation.

1.2.0-2.8.0

Created: | 2020-03-03T12:03:14.000Z
Author: | Istvan Mohacsi
Notes: |

1.1.2-2.7.0

Created: | 2020-02-20T11:52:23.000Z
Author: | Denys Mamchyk
Notes: | starts after waiting for a proper data aggregators state

1.1.1-2.6.0

Created: | 2019-09-27T11:19:01.000Z
Author: | Dennis Goeries
Notes: |

1.1.0-2.5.0

Created: | 2019-08-29T15:29:20.000Z
Author: | Dennis Goeries
Notes: |

1.0.2-2.5.0

Created: | 2019-07-09T09:22:23.000Z
Author: | Dennis Goeries
Notes: |

1.0.1-2.4.0

Created: | 2019-05-16T16:38:41.000Z
Author: | Istvan Mohacsi
Notes: |

1.0.0-2.4.0

Created: | 2019-04-15T15:45:23.000Z
Author: | Dennis Goeries
Notes: |

##### CAL

[add component documentation]

###### APPEND

Instance id: | SPB_IRDA_JF4M/CAL/APPEND
Class id: | CppFemCombiner
Host: | exflong02
Alias: | sa1-br-sys-cal-2 , spb-br-sys-cal-2
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/cppFemCombiner
Last modified: | 2020-11-20T16:46:45.000+01:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Ahmed, Michelat
Latest tag: | 1.4.3-2.9.1
Deployment tag: | 1.4.3-2.9.1
Scenes: | CAL_PIPELINE_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- inputs:
    Input for split data
- inputsOnSlowness:
    Policy for what to do if this input is too slow for the fed data rate (only used in copy mode)
- output:
    Output channel for combined data
- filteredOutput:
    Output channel for combined data, filtered to a single image
- indexToFilter:
    single frame for index >= 0, max pixel value across cells: -1, mean value over cells: -2, sum over cells: -3 standard deviation over cells : -4
- bufferLength:
    Length of buffer to hold non-complete trains in

Release History
1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

0.2-2.2.3.5

Created: | 2018-05-22T07:47:19.000Z
Author: | Steffen Hauf
Notes: |

0.1-2.2.3.5

Created: | 2018-05-15T13:16:05.000Z
Author: | Steffen Hauf
Notes: |

###### COMBINER

Instance id: | SPB_IRDA_JF4M/CAL/COMBINER
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-20T22:17:09.000+01:00
Created at: | 2017-03-10T08:22:26.000+01:00
Main authors: | Santos, Kamil, Samartsev
Latest tag: | 1.4.0-2.9.1
Deployment tag: | 1.4.0-2.9.1
Scenes: | SPB/SFX_Jungfrau, preview, test, RAW_PREVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings
- output:
    Output channel for combined data

Release History
1.4.0-2.9.1

Created: | 2020-07-23T13:57:30.000Z
Author: | Hugo Santos
Notes: |

1.3.1-2.7.0

Created: | 2020-01-28T09:49:16.000Z
Author: | scsonc
Notes: | 28.01.2020

1.3.0-2.4.1

Created: | 2019-05-02T08:14:16.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.3.4

Created: | 2019-02-08T12:54:06.000Z
Author: | Steffen Hauf
Notes: |

1.1.1-2.2.4

Created: | 2018-07-20T11:55:37.000Z
Author: | Andrea Parenti
Notes: | FIX ImageData encoding

1.1.0-2.2.3.5

Created: | 2018-05-17T06:20:59.000Z
Author: | Steffen Hauf
Notes: |

1.0.15-2.2.0

Created: | 2018-05-09T06:31:55.000Z
Author: | Steffen Hauf
Notes: |

1.0.14-2.2.0

Created: | 2018-03-27T07:31:11.000Z
Author: | Thomas Michelat
Notes: |

1.0.13-2.2.0

Created: | 2018-02-28T15:23:55.000Z
Author: | Dennis Goeries
Notes: |

1.0.12-2.2.0

Created: | 2018-02-23T09:45:16.000Z
Author: | Steffen Hauf
Notes: |

1.0.11-2.2.0

Created: | 2018-02-06T15:57:13.000Z
Author: | Steffen Hauf
Notes: |

1.0.10-2.2.0

Created: | 2018-01-15T09:43:49.000Z
Author: | Steffen Hauf
Notes: |

1.0.9-2.1.18

Created: | 2017-11-08T13:00:30.000Z
Author: | Thomas Michelat
Notes: |

1.0.8-2.1.18

Created: | 2017-11-08T09:40:13.000Z
Author: | Thomas Michelat
Notes: |

1.0.7-2.1.15

Created: | 2017-08-31T07:19:57.000Z
Author: | Thomas Michelat
Notes: |

1.0.6-2.1.12

Created: | 2017-08-21T07:13:12.000Z
Author: | Steffen Hauf
Notes: |

1.0.5-2.1.12

Created: | 2017-08-17T06:08:37.000Z
Author: | Steffen Hauf
Notes: |

1.0.4-2.1.12

Created: | 2017-08-11T10:51:58.000Z
Author: | Steffen Hauf
Notes: |

1.0.3-2.1.12

Created: | 2017-08-10T06:08:02.000Z
Author: | Steffen Hauf
Notes: |

1.0.2-2.1.12

Created: | 2017-08-09T12:32:58.000Z
Author: | Steffen Hauf
Notes: |

###### CORR_GAIN_M1

Instance id: | SPB_IRDA_JF4M/CAL/CORR_GAIN_M1
Class id: | RelativeGainCorrectionJungfrau
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-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: | CORRECTED_PREVIEW, test, CAL_PIPELINE_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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_M2

Instance id: | SPB_IRDA_JF4M/CAL/CORR_GAIN_M2
Class id: | RelativeGainCorrectionJungfrau
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-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: | preview, CORRECTED_PREVIEW, CAL_PIPELINE_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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_M3

Instance id: | SPB_IRDA_JF4M/CAL/CORR_GAIN_M3
Class id: | RelativeGainCorrectionJungfrau
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-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: | CORRECTED_PREVIEW, CAL_PIPELINE_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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_M6

Instance id: | SPB_IRDA_JF4M/CAL/CORR_GAIN_M6
Class id: | RelativeGainCorrectionJungfrau
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-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: | CORRECTED_PREVIEW, CAL_PIPELINE_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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_M7

Instance id: | SPB_IRDA_JF4M/CAL/CORR_GAIN_M7
Class id: | RelativeGainCorrectionJungfrau
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-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: | CORRECTED_PREVIEW, CAL_PIPELINE_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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_M8

Instance id: | SPB_IRDA_JF4M/CAL/CORR_GAIN_M8
Class id: | RelativeGainCorrectionJungfrau
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-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: | CORRECTED_PREVIEW, CAL_PIPELINE_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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_M1

Instance id: | SPB_IRDA_JF4M/CAL/CORR_OFFSET_M1
Class id: | OffsetCorrectionJungfrau
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-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: | preview, test, CAL_PIPELINE_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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_M2

Instance id: | SPB_IRDA_JF4M/CAL/CORR_OFFSET_M2
Class id: | OffsetCorrectionJungfrau
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-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: | preview, test, CAL_PIPELINE_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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_M3

Instance id: | SPB_IRDA_JF4M/CAL/CORR_OFFSET_M3
Class id: | OffsetCorrectionJungfrau
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-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: | test, CAL_PIPELINE_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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_M6

Instance id: | SPB_IRDA_JF4M/CAL/CORR_OFFSET_M6
Class id: | OffsetCorrectionJungfrau
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-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: | test, CAL_PIPELINE_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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_M7

Instance id: | SPB_IRDA_JF4M/CAL/CORR_OFFSET_M7
Class id: | OffsetCorrectionJungfrau
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-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: | test, CAL_PIPELINE_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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_M8

Instance id: | SPB_IRDA_JF4M/CAL/CORR_OFFSET_M8
Class id: | OffsetCorrectionJungfrau
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-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: | test, CAL_PIPELINE_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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: | SPB_IRDA_JF4M/CAL/MANAGER
Class id: | CalManager
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-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: | SPB/SFX_Jungfrau, CAL_PIPELINE_OVERVIEW, RAW_PREVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a TimeServer instance in the distributed system
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- Logger:
    Logging settings

Release History
1.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_M4

Instance id: | SPB_IRDA_JF4M/CAL/CORR_GAIN_M4
Class id: | RelativeGainCorrectionJungfrau
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-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: | CORRECTED_PREVIEW, CAL_PIPELINE_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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_M5

Instance id: | SPB_IRDA_JF4M/CAL/CORR_GAIN_M5
Class id: | RelativeGainCorrectionJungfrau
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-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: | CORRECTED_PREVIEW, CAL_PIPELINE_OVERVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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_M4

Instance id: | SPB_IRDA_JF4M/CAL/CORR_OFFSET_M4
Class id: | OffsetCorrectionJungfrau
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-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: | test, CAL_PIPELINE_OVERVIEW, ff
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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_M5

Instance id: | SPB_IRDA_JF4M/CAL/CORR_OFFSET_M5
Class id: | OffsetCorrectionJungfrau
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-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: | preview, test, CAL_PIPELINE_OVERVIEW, ff
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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: |

###### COMBINER_GAIN

Instance id: | SPB_IRDA_JF4M/CAL/COMBINER_GAIN
Class id: | FemDataAssembler
Host: | exflong04
Alias: | spb-br-sys-cal-4 , sa1-br-sys-cal-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/femDataSplitter
Last modified: | 2020-11-20T22:17:09.000+01:00
Created at: | 2017-03-10T08:22:26.000+01:00
Main authors: | Santos, Kamil, Samartsev
Latest tag: | 1.4.0-2.9.1
Deployment tag: | 1.4.0-2.9.1
Scenes: | SPB/SFX_Jungfrau, RAW_PREVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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
- transposeDims:
    Transpose dimensions of data input array

Release History
1.4.0-2.9.1

Created: | 2020-07-23T13:57:30.000Z
Author: | Hugo Santos
Notes: |

1.3.1-2.7.0

Created: | 2020-01-28T09:49:16.000Z
Author: | scsonc
Notes: | 28.01.2020

1.3.0-2.4.1

Created: | 2019-05-02T08:14:16.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.3.4

Created: | 2019-02-08T12:54:06.000Z
Author: | Steffen Hauf
Notes: |

1.1.1-2.2.4

Created: | 2018-07-20T11:55:37.000Z
Author: | Andrea Parenti
Notes: | FIX ImageData encoding

1.1.0-2.2.3.5

Created: | 2018-05-17T06:20:59.000Z
Author: | Steffen Hauf
Notes: |

1.0.15-2.2.0

Created: | 2018-05-09T06:31:55.000Z
Author: | Steffen Hauf
Notes: |

1.0.14-2.2.0

Created: | 2018-03-27T07:31:11.000Z
Author: | Thomas Michelat
Notes: |

1.0.13-2.2.0

Created: | 2018-02-28T15:23:55.000Z
Author: | Dennis Goeries
Notes: |

1.0.12-2.2.0

Created: | 2018-02-23T09:45:16.000Z
Author: | Steffen Hauf
Notes: |

1.0.11-2.2.0

Created: | 2018-02-06T15:57:13.000Z
Author: | Steffen Hauf
Notes: |

1.0.10-2.2.0

Created: | 2018-01-15T09:43:49.000Z
Author: | Steffen Hauf
Notes: |

1.0.9-2.1.18

Created: | 2017-11-08T13:00:30.000Z
Author: | Thomas Michelat
Notes: |

1.0.8-2.1.18

Created: | 2017-11-08T09:40:13.000Z
Author: | Thomas Michelat
Notes: |

1.0.7-2.1.15

Created: | 2017-08-31T07:19:57.000Z
Author: | Thomas Michelat
Notes: |

1.0.6-2.1.12

Created: | 2017-08-21T07:13:12.000Z
Author: | Steffen Hauf
Notes: |

1.0.5-2.1.12

Created: | 2017-08-17T06:08:37.000Z
Author: | Steffen Hauf
Notes: |

1.0.4-2.1.12

Created: | 2017-08-11T10:51:58.000Z
Author: | Steffen Hauf
Notes: |

1.0.3-2.1.12

Created: | 2017-08-10T06:08:02.000Z
Author: | Steffen Hauf
Notes: |

1.0.2-2.1.12

Created: | 2017-08-09T12:32:58.000Z
Author: | Steffen Hauf
Notes: |

###### COMBINER_RAW

Instance id: | SPB_IRDA_JF4M/CAL/COMBINER_RAW
Class id: | FemDataAssembler
Host: | exflong04
Alias: | spb-br-sys-cal-4 , sa1-br-sys-cal-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/femDataSplitter
Last modified: | 2020-11-20T22:17:09.000+01:00
Created at: | 2017-03-10T08:22:26.000+01:00
Main authors: | Santos, Kamil, Samartsev
Latest tag: | 1.4.0-2.9.1
Deployment tag: | 1.4.0-2.9.1
Scenes: | RAW_PREVIEW
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

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
- transposeDims:
    Transpose dimensions of data input array

Release History
1.4.0-2.9.1

Created: | 2020-07-23T13:57:30.000Z
Author: | Hugo Santos
Notes: |

1.3.1-2.7.0

Created: | 2020-01-28T09:49:16.000Z
Author: | scsonc
Notes: | 28.01.2020

1.3.0-2.4.1

Created: | 2019-05-02T08:14:16.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.3.4

Created: | 2019-02-08T12:54:06.000Z
Author: | Steffen Hauf
Notes: |

1.1.1-2.2.4

Created: | 2018-07-20T11:55:37.000Z
Author: | Andrea Parenti
Notes: | FIX ImageData encoding

1.1.0-2.2.3.5

Created: | 2018-05-17T06:20:59.000Z
Author: | Steffen Hauf
Notes: |

1.0.15-2.2.0

Created: | 2018-05-09T06:31:55.000Z
Author: | Steffen Hauf
Notes: |

1.0.14-2.2.0

Created: | 2018-03-27T07:31:11.000Z
Author: | Thomas Michelat
Notes: |

1.0.13-2.2.0

Created: | 2018-02-28T15:23:55.000Z
Author: | Dennis Goeries
Notes: |

1.0.12-2.2.0

Created: | 2018-02-23T09:45:16.000Z
Author: | Steffen Hauf
Notes: |

1.0.11-2.2.0

Created: | 2018-02-06T15:57:13.000Z
Author: | Steffen Hauf
Notes: |

1.0.10-2.2.0

Created: | 2018-01-15T09:43:49.000Z
Author: | Steffen Hauf
Notes: |

1.0.9-2.1.18

Created: | 2017-11-08T13:00:30.000Z
Author: | Thomas Michelat
Notes: |

1.0.8-2.1.18

Created: | 2017-11-08T09:40:13.000Z
Author: | Thomas Michelat
Notes: |

1.0.7-2.1.15

Created: | 2017-08-31T07:19:57.000Z
Author: | Thomas Michelat
Notes: |

1.0.6-2.1.12

Created: | 2017-08-21T07:13:12.000Z
Author: | Steffen Hauf
Notes: |

1.0.5-2.1.12

Created: | 2017-08-17T06:08:37.000Z
Author: | Steffen Hauf
Notes: |

1.0.4-2.1.12

Created: | 2017-08-11T10:51:58.000Z
Author: | Steffen Hauf
Notes: |

1.0.3-2.1.12

Created: | 2017-08-10T06:08:02.000Z
Author: | Steffen Hauf
Notes: |

1.0.2-2.1.12

Created: | 2017-08-09T12:32:58.000Z
Author: | Steffen Hauf
Notes: |

###### APPEND_RAW

Instance id: | SPB_IRDA_JF4M/CAL/APPEND_RAW
Class id: | CppFemCombiner
Host: | exflong04
Alias: | spb-br-sys-cal-4 , sa1-br-sys-cal-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/cppFemCombiner
Last modified: | 2020-11-20T16:46:45.000+01:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Ahmed, Michelat
Latest tag: | 1.4.3-2.9.1
Deployment tag: | 1.4.3-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- inputs:
    Input for split data
- inputsOnSlowness:
    Policy for what to do if this input is too slow for the fed data rate (only used in copy mode)
- output:
    Output channel for combined data
- filteredOutput:
    Output channel for combined data, filtered to a single image
- indexToFilter:
    single frame for index >= 0, max pixel value across cells: -1, mean value over cells: -2, sum over cells: -3 standard deviation over cells : -4
- bufferLength:
    Length of buffer to hold non-complete trains in

Release History
1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

0.2-2.2.3.5

Created: | 2018-05-22T07:47:19.000Z
Author: | Steffen Hauf
Notes: |

0.1-2.2.3.5

Created: | 2018-05-15T13:16:05.000Z
Author: | Steffen Hauf
Notes: |

###### APPEND_GAIN

Instance id: | SPB_IRDA_JF4M/CAL/APPEND_GAIN
Class id: | CppFemCombiner
Host: | exflong04
Alias: | spb-br-sys-cal-4 , sa1-br-sys-cal-4
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/cppFemCombiner
Last modified: | 2020-11-20T16:46:45.000+01:00
Created at: | 2018-05-15T15:17:31.000+02:00
Main authors: | Danilevski, Ahmed, Michelat
Latest tag: | 1.4.3-2.9.1
Deployment tag: | 1.4.3-2.9.1
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Calibration Troubleshooting

General online calibration can be found here.

For resolving issues concerning detector related DAQ check this page.

Disabling Calibration Constants

An (expert) tutorial on how to disable calibration constants can be found here.

If you have questions, contact det-support@xfel.eu

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- progress:
    The progress of the current action
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- inputs:
    Input for split data
- inputsOnSlowness:
    Policy for what to do if this input is too slow for the fed data rate (only used in copy mode)
- output:
    Output channel for combined data
- filteredOutput:
    Output channel for combined data, filtered to a single image
- indexToFilter:
    single frame for index >= 0, max pixel value across cells: -1, mean value over cells: -2, sum over cells: -3 standard deviation over cells : -4
- bufferLength:
    Length of buffer to hold non-complete trains in

Release History
1.4.3-2.9.1

Created: | 2020-08-25T10:13:39.000Z
Author: | Thomas Michelat
Notes: |

1.4.2-2.9.1

Created: | 2020-08-24T17:11:45.000Z
Author: | Thomas Michelat
Notes: | configurable behavior on slowness

1.4.1-2.9.1

Created: | 2020-07-08T10:50:55.000Z
Author: | Karim Ahmed
Notes: | Phase III deployed and tested

1.4.0-2.7.1

Created: | 2020-05-05T12:25:56.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test02

Created: | 2020-04-07T14:27:25.000Z
Author: | Karim Ahmed
Notes: |

1.4.0-2.7.1-test01

Created: | 2020-02-27T16:35:08.000Z
Author: | Karim Ahmed
Notes: |

1.3.2-2.7.1

Created: | 2020-02-11T11:00:10.000Z
Author: | Karim Ahmed
Notes: |

1.3.1-2.5.0

Created: | 2019-07-30T08:21:54.000Z
Author: | Steffen Hauf
Notes: |

1.3.0-2.4.1

Created: | 2019-07-02T09:46:52.000Z
Author: | Steffen Hauf
Notes: |

1.2.1-2.4.1

Created: | 2019-05-09T17:17:42.000Z
Author: | Steffen Hauf
Notes: |

1.2.0-2.4.1

Created: | 2019-05-02T08:17:59.000Z
Author: | Steffen Hauf
Notes: |

1.1-2.4.1-dev

Created: | 2019-04-24T11:29:04.000Z
Author: | Steffen Hauf
Notes: |

1.0-2.3.4

Created: | 2019-02-08T12:52:33.000Z
Author: | Steffen Hauf
Notes: |

0.7-2.3.4

Created: | 2019-02-08T08:37:12.000Z
Author: | Steffen Hauf
Notes: |

0.6-2.3.1

Created: | 2019-01-29T13:06:13.000Z
Author: | Steffen Hauf
Notes: |

0.5-2.2.4

Created: | 2018-09-26T08:20:08.000Z
Author: | Steffen Hauf
Notes: |

0.4-2.2.4

Created: | 2018-08-16T08:44:38.000Z
Author: | Steffen Hauf
Notes: |

0.3-2.2.4

Created: | 2018-08-07T06:13:23.000Z
Author: | Steffen Hauf
Notes: |

0.2-2.2.3.5

Created: | 2018-05-22T07:47:19.000Z
Author: | Steffen Hauf
Notes: |

0.1-2.2.3.5

Created: | 2018-05-15T13:16:05.000Z
Author: | Steffen Hauf
Notes: |

##### BRIDGE

[add component documentation]

###### JNGFR01_RAW

Instance id: | SPB_IRDA_JF4M/BRIDGE/JNGFR01_RAW
Class id: | PipeToZeroMQ
Host: | exflonc01
Alias: | sa1-br-kc-comp-1 , la1-br-kc-comp-1
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/PipeToZeroMQ
Last modified: | 2020-07-17T18:18:44.000+02:00
Created at: | 2017-07-31T19:55:21.000+02:00
Main authors: | Michelat, Tmichela
Latest tag: | 3.1.1-2.9.0
Deployment tag: | 3.1.1-2.9.0
Accessible by: |

Warning

Host not accessible by [‘xctrl’, ‘spbonc’]!

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- useTimeserver:
    Unused - whether device connects to time server is configured via ‘timeServerId’
- timeServerId:
    The instance id uniquely identifies a 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
- addressOutput1:
    Address to use to get data from this output
- data_sent1:
    Count total of train data sent on this output
- addressOutput2:
    Address to use to get data from this output
- data_sent2:
    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: |

#### INLINEMIC

[add component documentation]

##### CAM

[add component documentation]

###### CAM

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

##### TSYS

[add component documentation]

###### CAM_TRG

Instance id: | SPB_IRDA_INLINEMIC/TSYS/CAM_TRG
Class id: | X2TimerML
Host: | spb-rr-sys-con-06
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2021-05-07T16:06:25.000+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.0-2.10.4
Deployment tag: | 1.4.0-2.10.4
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.0-2.10.4

Created: | 2021-05-07T14:01:37.000Z
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

##### PROC

[add component documentation]

###### BEAM_SHAPE_COARSE

Instance id: | SPB_IRDA_INLINEMIC/PROC/BEAM_SHAPE_COARSE
Class id: | BeamShapeCoarse
Host: | spb-rr-sys-con-spc
Alias: | spb-rr-sys-con-spc
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: | IRDA_INLINEMIC_beam_shape_coarse
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!

Beam Shape Coarse

The `BeamShapeCoarse` device is part of the imageProcessor package, and is documented in imageprocessor:image-beam-shape-user

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- x0:
    X coordinate of the maximum intensity pixel.
- y0:
    Y coordinate of the maximum intensity pixel.
- fwhmX:
    Full Width at Half Maximum for X projection, A.K.A. beam width.
- fwhmY:
    Full Width at Half Maximum for Y projection, A.K.A. beam height.
- frameRate:
    Rate of processed images.
- resetError:
    Reset error count.

Release History
1.27.4-2.10.0

Created: | 2020-11-23T11:51:09.000Z
Author: | Gabriele Giovanetti
Notes: | Karabo 2.10 versioning

1.27.4-2.9.1

Created: | 2020-07-30T12:29:13.000Z
Author: | Andrea Parenti
Notes: | Reset properties only once

1.27.3-2.9.1

Created: | 2020-07-28T12:08:55.000Z
Author: | Andrea Parenti
Notes: | Calculate min/max/mean pixel value after background and pedestal subtraction

1.27.2-2.9.1

Created: | 2020-07-06T11:53:30.000Z
Author: | Riccardo Fabbri
Notes: | Integral over axes (img_x/y) corrected when no “user-defined” is set

1.27.1-2.8.0

Created: | 2020-03-17T10:23:50.000Z
Author: | Andrea Parenti
Notes: | Fix MDL’s error count reconfiguration + resetError function

1.27.0-2.7.0

Created: | 2020-03-12T15:58:22.000Z
Author: | Andrea Parenti
Notes: | Update for error resetting, and reconfiguration of threshold and epsilon parameters of error counter

1.26.0-2.7.0

Created: | 2019-12-10T13:13:22.000Z
Author: | Andrea Parenti
Notes: | Alarm condition with warning, imageProcessing updated to version 2.3.5-2.6

1.25.0-2.6.2

Created: | 2019-09-25T07:12:39.000Z
Author: | Andrea Parenti
Notes: | ImageToSpectrum: make direction of integral configurable.

1.24.3-2.6.1

Created: | 2019-09-17T15:59:16.000Z
Author: | Robert Schaffer
Notes: | Added peak ratio for TwoPeakFinder device.

1.24.2-2.6.1

Created: | 2019-09-05T15:06:43.000Z
Author: | Robert Schaffer
Notes: | Implemented thresholding for integrated data intensities.

1.24.1-2.6.1

Created: | 2019-09-04T12:46:06.000Z
Author: | Andrea Parenti
Notes: | FIX 1D data ImageAverager

1.24.0-2.5.1

Created: | 2019-08-22T14:57:59.000Z
Author: | Cyril Danilevski
Notes: | Add possibility to average spectra (1D images)

1.23.2-2.5.0

Created: | 2019-07-10T07:31:19.000Z
Author: | Andrea Parenti
Notes: | FIX processing of spectra

1.23.1-2.5.0

Created: | 2019-07-05T14:19:56.000Z
Author: | Gabriele Giovanetti
Notes: |

1.23.0-2.5

Created: | 2019-07-01T08:20:28.000Z
Author: | Gabriele Giovanetti
Notes: | WARNING: this tag is not to be used with Karabo version < 2.5 * Improved Error state handling 1d images (spectra) processing Fix for empty auto-range

1.22.0-2.4.2

Created: | 2019-06-18T11:41:45.000Z
Author: | Andrea Parenti
Notes: | Add possibility to process spectra (1D images)

1.21.0-2.4.1

Created: | 2019-05-09T14:59:33.000Z
Author: | Andrea Parenti
Notes: | Adding option for lightweight exponential running average

1.20.0-2.4.0

Created: | 2019-04-30T12:34:21.000Z
Author: | Robert Schaffer
Notes: | Fixed a bug causing thresholding downstream of COM calculation

1.19.0-2.3.7

Created: | 2019-03-26T17:58:39.000Z
Author: | Wajid Ehsan
Notes: | Include roi in y-direction imageTospectrum

1.18.0-2.3.5

Created: | 2019-02-21T09:22:07.000Z
Author: | Andrea Parenti
Notes: | add ImageBackgroundSubtraction device; add documentation for TwoPeakFinder.

#### SIDEMIC

[add component documentation]

##### CAM

[add component documentation]

###### CAM

GENICAM CAMERAS

The documentation of the Karabo devices for GenICam cameras can be found here

##### TSYS

[add component documentation]

###### CAM_TRG

Instance id: | SPB_IRDA_SIDEMIC/TSYS/CAM_TRG
Class id: | X2TimerML
Host: | spb-rr-sys-con-06
Alias: | spb-rr-sys-con-06
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/x2TimerML
Last modified: | 2021-05-07T16:06:25.000+02:00
Created at: | 2017-06-02T10:18:35.000+02:00
Main authors: | Hauf, Haufs, Ehsan
Latest tag: | 1.4.0-2.10.4
Deployment tag: | 1.4.0-2.10.4
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

Installation not found in a standard path!

X2 Timer MDL

The `X2TimerML` device is a middlelayer control device which offers a simplified user interface for controlling the X2Timer device. It is documented in x2timerml:welcome

The X2 Timer should be controller via the X2 Timer MDL device, which is docmented in x2timerml:welcome.

Device Schema Description

- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- heartbeatInterval:
    The heartbeat interval
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- globalAlarmCondition:
    This is the global alarm condition for this device. The current alarm condition of this device will be calculated from this alarm condition and the alarm condition of each property.
- visibility:
    Configures who is allowed to see this device at all
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server
- pid:
    The unix process ID of the device (i.e. of the server)
- state:
    The current state the device is in
- status:
    A more detailed status description
- lockedBy:
    The name of the device holding a lock on this one (empty if not locked)
- slotClearLock:
    Clear the lock on this device
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- log:
    Logging settings
- x2Timer:
    Device ID of X2Timer
- channelName:
    Input (e.g. frontTrg1 or rtmTrg9)
- setControl:
    Set the control value
- condTriggerOn:
    Value of corresponding bits of channel’s “CONTROL” property to enable “Conditional Trigger” mode. Check with experts from AE before changing this.
- condTriggerOff:
    Value of corresponding bits of channel’s “CONTROL” property to enable “10Hz Trigger” mode. Check with experts from AE before changing this.
- condTriggerMask:
    Mask for bits of channel’s “CONTROL” property to be changed when switching mode. Check with experts from AE before changing this.
- useCondTrigger:
    The flag toggles between “10Hz Trigger” mode and “Conditional Trigger” mode.
- enableOutput:
    Enable/disable the signal
- invertTrigger:
    Invert the trigger signal.
- actualDelay:
    The actual coarse delay in ns. Warns if delay is longer than 0.1 s, as you might be off by a train.
- targetDelay:
    The target coarse delay in ns. Press ‘Set Delay’ to apply this value.
- setDelay:
    Set the delay in nano sec.
- targetDuration:
    The target duration. Press ‘Set Duration’ to apply this value.
- setDuration:
    Set the duration.
- maxTrainFreq:
    Maximum bunch train frequency with current trigger duration.
- targetPulseEvent:
    The target macro P-Event. Press ‘Set Macro P-Event’ to apply this value.
- setPulseEvent:
    Set the macro P-Event.
- targetPicoDelay:
    The target pico-delay. Press ‘Set Pico Delay’ to apply this value.
- setPicoDelay:
    Set the pico delay.
- targetInhibit:
    The target inhibit. Press ‘Set Inhibit’ to apply this value.
- setInhibit:
    Set the inhibit.
- usePicoDelay:
    If enable, It will provide the possibility of tuning the delay into additional 10 sub-steps in between the step size of 9.23 ns.
- actualPosition:
    Actual position used for scanning.
- targetPosition:
    Target position used for scanning.
- move:
    Move command.
- stop:
    Stop command.
- stepSize:
    Step size for up and down button
- stepMult2:
    Multiply the step size by 2.
- stepDiv2:
    Divide the step size by 2.
- stepUp:
    Increase delay by one step.
- stepDown:
    Decrease delay by one step.

Release History
1.4.0-2.10.4

Created: | 2021-05-07T14:01:37.000Z
Author: | David Hickin
Notes: | feature: enableOutput boolean to enable/disable the channel signal

1.3.4-2.10.0

Created: | 2020-11-23T12:32:43.000Z
Author: | Wajid Ehsan
Notes: | version update

1.3.3-2.9.1

Created: | 2020-08-18T10:40:13.000Z
Author: | David Hickin
Notes: | Fix error for control with conditional trigger neither off or on

1.3.2-2.7.0

Created: | 2020-03-06T16:26:12.000Z
Author: | Wajid Ehsan
Notes: | Fix the unit issue and change state before calling slot

1.2.6-2.6.4-hotfix

Created: | 2020-03-04T13:52:19.000Z
Author: | degon
Notes: |

1.3.1-2.7.0

Created: | 2020-02-12T13:34:06.000Z
Author: | David Hickin
Notes: |

1.3.0-2.7.0

Created: | 2020-01-27T14:40:18.000Z
Author: | David Hickin
Notes: |

1.2.6-2.6.4

Created: | 2020-01-20T13:28:36.000Z
Author: | Wajid Ehsan
Notes: |

1.2.5-2.6.4

Created: | 2019-12-20T15:30:13.000Z
Author: | Wajid Ehsan
Notes: | Fix scanning mode

1.2.4-2.6.4

Created: | 2019-11-12T17:12:29.000Z
Author: | Wajid Ehsan
Notes: | Fix typeError

1.2.3-2.6.4

Created: | 2019-11-11T14:39:22.000Z
Author: | Wajid Ehsan
Notes: | Remove Max limit of target position

1.2.2-2.6.4

Created: | 2019-11-07T10:20:12.000Z
Author: | Andrea Parenti
Notes: | Make Macro P-Event reconfigurable Improve description of target values

1.2.1-2.6.1

Created: | 2019-10-21T12:32:11.000Z
Author: | Riccardo Fabbri
Notes: | Initial documentation added

1.2.0-2.4.0

Created: | 2019-06-03T12:55:56.000Z
Author: | Denys Mamchyk
Notes: | Toggling between “10Hz Trigger” mode and “Conditional Trigger” mode added

1.2.0conditional-2.4.0

Created: | 2019-05-02T16:25:20.000Z
Author: | Denys Mamchyk
Notes: | Conditional trigger test

1.1.1-2.2.4

Created: | 2018-07-25T13:45:47.000Z
Author: | Andrea Parenti
Notes: | FIX - Make EVENT property read-only

1.1.0-2.2.4

Created: | 2018-06-12T14:00:31.000Z
Author: | Wajid Ehsan
Notes: | Refactor for DAQ

1.0.9-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.8-2.1.18

Created: | 2018-03-07T12:55:02.000Z
Author: | Dennis Goeries
Notes: |

1.0.7-2.1.18

Created: | 2018-03-06T12:31:17.000Z
Author: | Dennis Goeries
Notes: |

#### LIC

[add component documentation]

##### DCTRL

[add component documentation]

###### CAMERA_1030NM

Instance id: | SPB_IRDA_LIC/DCTRL/CAMERA_1030NM
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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

###### CAMERA_800NM

Instance id: | SPB_IRDA_LIC/DCTRL/CAMERA_800NM
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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

###### CAMERA_TT

Instance id: | SPB_IRDA_LIC/DCTRL/CAMERA_TT
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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

##### MOTOR

[add component documentation]

###### ATT_AZ

###### DELAY_Z

###### MIRROR1_AX

###### MIRROR1_AY

### IRD

[add component documentation]

#### VAC

[add component documentation]

##### VALVE

[add component documentation]

###### VALVE_VENT_3

Instance id: | SPB_IRD_VAC/VALVE/VALVE_VENT_3
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### VALVE_INLINE_1

Instance id: | SPB_IRD_VAC/VALVE/VALVE_INLINE_1
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### VALVE_INLINE_2

Instance id: | SPB_IRD_VAC/VALVE/VALVE_INLINE_2
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### VALVE_INLINE_3

Instance id: | SPB_IRD_VAC/VALVE/VALVE_INLINE_3
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### VALVE_LOCK_1

Instance id: | SPB_IRD_VAC/VALVE/VALVE_LOCK_1
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### VALVE_LOCK_2

Instance id: | SPB_IRD_VAC/VALVE/VALVE_LOCK_2
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### VALVE_LOCK_4

Instance id: | SPB_IRD_VAC/VALVE/VALVE_LOCK_4
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### VALVE_ROUGH_1

Instance id: | SPB_IRD_VAC/VALVE/VALVE_ROUGH_1
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-2.11.1
Scenes: | Rough-Vacuum, Instrument-Overview-Long, Instrument-Overview-Long-NoCRL, SAXS-Instrument-Overview-NotUTD, Instrument-Overview-Long, Instrument-Overview-Long, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_ROUGH_2

Instance id: | SPB_IRD_VAC/VALVE/VALVE_ROUGH_2
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### VALVE_ROUGH_3

Instance id: | SPB_IRD_VAC/VALVE/VALVE_ROUGH_3
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### VALVE_ROUGH_4

Instance id: | SPB_IRD_VAC/VALVE/VALVE_ROUGH_4
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### VALVE_ROUGH_5

Instance id: | SPB_IRD_VAC/VALVE/VALVE_ROUGH_5
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### VALVE_ROUGH_6

Instance id: | SPB_IRD_VAC/VALVE/VALVE_ROUGH_6
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### VALVE_VENT_1

Instance id: | SPB_IRD_VAC/VALVE/VALVE_VENT_1
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### VALVE_VENT_2

Instance id: | SPB_IRD_VAC/VALVE/VALVE_VENT_2
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

##### GAUGE

[add component documentation]

###### GAUGE_PR_9

Instance id: | SPB_IRD_VAC/GAUGE/GAUGE_PR_9
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_1

Instance id: | SPB_IRD_VAC/GAUGE/GAUGE_FR_1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-2.11.1
Scenes: | Instrument-Overview-Long, Instrument-Overview-Long-NoCRL, Instrument-Overview-Long-IRDa, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_2

Instance id: | SPB_IRD_VAC/GAUGE/GAUGE_FR_2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_3

Instance id: | SPB_IRD_VAC/GAUGE/GAUGE_FR_3
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-2.11.1
Scenes: | Instrument-Overview-Long, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_4

Instance id: | SPB_IRD_VAC/GAUGE/GAUGE_FR_4
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-2.11.1
Scenes: | Instrument-Overview-Long-NoCRL, Instrument-Overview-Long-IRDa
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_5

Instance id: | SPB_IRD_VAC/GAUGE/GAUGE_FR_5
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_6

Instance id: | SPB_IRD_VAC/GAUGE/GAUGE_FR_6
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_PR_1

Instance id: | SPB_IRD_VAC/GAUGE/GAUGE_PR_1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_PR_2

Instance id: | SPB_IRD_VAC/GAUGE/GAUGE_PR_2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_PR_3

Instance id: | SPB_IRD_VAC/GAUGE/GAUGE_PR_3
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_PR_4

Instance id: | SPB_IRD_VAC/GAUGE/GAUGE_PR_4
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_PR_5

Instance id: | SPB_IRD_VAC/GAUGE/GAUGE_PR_5
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_PR_6

Instance id: | SPB_IRD_VAC/GAUGE/GAUGE_PR_6
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_PR_7

Instance id: | SPB_IRD_VAC/GAUGE/GAUGE_PR_7
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_PR_8

Instance id: | SPB_IRD_VAC/GAUGE/GAUGE_PR_8
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

##### PUMP

[add component documentation]

###### PUMP_SCROLL_1

###### PUMP_ROOT_1

Instance id: | SPB_IRD_VAC/PUMP/PUMP_ROOT_1
Class id: | BeckhoffAdixenRoot
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAdixenRoot
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- isMotorTempWarning:
    Only valid for 19 pins HW I/F
- isOn:
    True when main pump is switched on
- isRunning:
    Feedback from the Pump if it is actually running
- isPumpWarning:
    indicates that the pump has a warning
- isStarting:
    True when pump is starting
- isPumpAlarm:
    Pump is in an alarm state or has encountered a hazard
- on:
    Switch on pump
- off:
    Switch off pump
- pumpPins:
    number of signals of pump hardware interface
- pumpFrequency:
    Pump frequency
- freqPercentage:
    Pump frequency percentage with respect to the maximum
- finalValveInterlock:
    Valve should not be opened when true

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

##### SERIAL

[add component documentation]

###### PUMP_ROOT_1

Instance id: | SPB_IRD_VAC/SERIAL/PUMP_ROOT_1
Class id: | BeckhoffAdixenRoot
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAdixenRoot
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- isMotorTempWarning:
    Only valid for 19 pins HW I/F
- isOn:
    True when main pump is switched on
- isRunning:
    Feedback from the Pump if it is actually running
- isPumpWarning:
    indicates that the pump has a warning
- isStarting:
    True when pump is starting
- isPumpAlarm:
    Pump is in an alarm state or has encountered a hazard
- on:
    Switch on pump
- off:
    Switch off pump
- pumpPins:
    number of signals of pump hardware interface
- pumpFrequency:
    Pump frequency
- freqPercentage:
    Pump frequency percentage with respect to the maximum
- finalValveInterlock:
    Valve should not be opened when true

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

##### SWITCH

[add component documentation]

###### PA_AIR

Instance id: | SPB_IRD_VAC/SWITCH/PA_AIR
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T09:55:43.000Z
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

###### DI_1

Instance id: | SPB_IRD_VAC/SWITCH/DI_1
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T09:55:43.000Z
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

###### DI_2

Instance id: | SPB_IRD_VAC/SWITCH/DI_2
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

Release History
4.6.4-2.11.1-peltier-hotfix-@SPB

Created: | 2021-06-23T14:13:27.000Z
Author: | xctrl
Notes: |

4.6.4-2.11.1

Created: | 2021-06-22T11:56:55.000Z
Author: | Alessandro Silenzi
Notes: | Fix for MC2 Elmo Feedback Configuration Options Optional sequential instantiation of Beckhoff devices for large loops Other optimizations

4.6.3-2.11.1

Created: | 2021-06-14T14:09:11.000Z
Author: | Gabriele Giovanetti
Notes: | Added BeckhoffDryPump

4.6.2-2.11.0

Created: | 2021-06-10T09:55:43.000Z
Author: | Alessandro Silenzi
Notes: | Alarm conditions and state are not set on new schema. (Fixes bug seen in BeckhoffFuse after Karabo 2.11.1 deployment)

4.6.1-2.11.0

Created: | 2021-06-07T17:31:48.000Z
Author: | Valerii Bondar
Notes: | Summer shutdown release, Fuse device added

4.6.0-2.11.0-rc2

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: |

4.6.0-2.11.0

Created: | 2021-06-02T12:39:34.000Z
Author: | Gabriele Giovanetti
Notes: | Summer shutdown release Devices added: BeckhoffTrainTrigger, BeckhoffLed, BeckhoffMC2Hexapod (BeckhoffMC2Base subclass), BeckhoffMC2Elmo (BeckhoffMC2Base subclass) Features: parameter deprecation in MC2 subclasses follow STOPPING state in Adixen Turbo Full pump. + other minor Fixes: * stepUp/stepDown popup error * epsilon feedback disable on write * avoid extra updates for interlock keys + other minor fixes

4.6.0-2.11.0-rc1

Created: | 2021-05-31T07:49:13.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-04

Created: | 2021-04-26T12:46:29.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-03

Created: | 2021-04-23T06:19:59.000Z
Author: | Gabriele Giovanetti
Notes: |

4.4.6-2.10.0-hotfix-02

Created: | 2021-04-23T05:43:58.000Z
Author: | Steffen Hauf
Notes: |

4.4.6-2.10.0-hotfix-01

Created: | 2021-04-15T16:15:29.000Z
Author: | Riccardo Fabbri
Notes: |

4.5.0-2.10.0

Created: | 2021-03-24T08:43:30.000Z
Author: | Steffen Hauf
Notes: | Add the AIBS

4.4.6-2.10.0

Created: | 2021-03-08T08:52:30.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added auto-generated scene for Pfeiffer vacuum controller IMG400

4.4.5-2.10.0

Created: | 2021-02-26T14:51:42.000Z
Author: | Riccardo Fabbri
Notes: | Summary: Added class for Pfeiffer vacuum controller IMG400

4.4.4-2.10.0

Created: | 2021-02-19T09:42:02.000Z
Author: | Wajid Ehsan
Notes: | Minor update to the device-generated scene for MC2 Motor

4.4.3-2.10.0

Created: | 2021-02-10T15:45:51.000Z
Author: | Wajid Ehsan
Notes: | Upgrade device-generated scene for MC2 Motor

4.4.2-2.10.0

Created: | 2021-01-13T11:22:16.000Z
Author: | Alessandro Silenzi
Notes: | This tag is for forward compatibility with 2.11.0, no deployment necessary. FIX: remove useTimeserver option

4.4.1-2.10.0

Created: | 2020-11-30T15:34:10.000Z
Author: | Alessandro Silenzi
Notes: | FIX: MC2 align to latest plc version FIX/FEAT: Dynamically adapt to plc framework changes by matching self description FIX: adapt release CI to 2.10 FIX: make version string match standard

4.4.0-2.10.0

Created: | 2020-11-23T15:52:07.000Z
Author: | Alessandro Silenzi
Notes: | FIX: Recover more reliably from flickering states FEAT: Add a method for querying if BeckhoffCom is busy FIX: Do not throw on missing interlock detail key FEAT: Use shared_mutex in BeckhoffCom FIX: MC2: hide double state update after move command WORKAROUND: Max Update queue on BeckhoffCom FIX: Refactor Trigger setting FEAT: separate TCP and broker tasks FEAT: No “broker” logs FIX: adapt digital input to PLC version 1.52 FEAT: Implement TCP write in an asynchronous way FEAT: Adapt Compiler to the laster

###### DI_3

Instance id: | SPB_IRD_VAC/SWITCH/DI_3
Class id: | BeckhoffDigitalInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffDigitalInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffDigitalInput Documentation

The `BeckhoffDigitalInput` device is documented in beckhoff:BeckhoffDigitalInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- invert:
    If set, the digital value as received from the hardware is inverted.
- edgeCount:
    Counter of the input edges
- fallingEdgeCounter:
    True - Counter On Falling Edge; False - Counter on Raising Edge.
- resetCounter:
    Reset count of edges

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

##### TPUMP

[add component documentation]

###### PUMP_TURBO_9

Instance id: | SPB_IRD_VAC/TPUMP/PUMP_TURBO_9
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### PUMP_TURBO_1

Instance id: | SPB_IRD_VAC/TPUMP/PUMP_TURBO_1
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-2.11.1
Scenes: | Turbo-control-old, Instrument-Overview-Long, IBS_turbo, Instrument-Overview-Long_SAXS, Turbo-control, Turbo-control
Accessible by: | CONTROLS, CTRL, DA, danilevc, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### PUMP_TURBO_10

Instance id: | SPB_IRD_VAC/TPUMP/PUMP_TURBO_10
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### PUMP_TURBO_2

Instance id: | SPB_IRD_VAC/TPUMP/PUMP_TURBO_2
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### PUMP_TURBO_3

Instance id: | SPB_IRD_VAC/TPUMP/PUMP_TURBO_3
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### PUMP_TURBO_4

Instance id: | SPB_IRD_VAC/TPUMP/PUMP_TURBO_4
Class id: | BeckhoffAdixenTurboFull
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAdixenTurboFull
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- standbyMode:
    When Standby Mode is selected, the pump speed will match the speed setpoint.
- nominalMode:
    When Nominal Mode is selected, the pump speed will match the nominally defined speed setpoint.
- off:
    Turn the pump off.
- on:
    Turn the pump on.
- pGroup:
    Remote has been configured via the device interface to allow remote commands when true.
- hardwareDeviceId:
    The Hardware Device ID. This value can range from 000 - 255, with a default value of 000
- isOn:
    True when pump is switched on
- isPurgeValveOpen:
    True when purge valve is open (e.g. while stopping).
- isVentValveOpen:
    True when vent valve is open
- isStandby:
    True when pump in in standby
- isWarning:
    True when pump has a warning active
- isOnTarget:
    True when pump is on target pressure
- isStarting:
    True when pump is starting
- isStopping:
    True when pump is stopping
- isStandbyMode:
    True when pump is in standby mode
- isSerialCtrl:
    True when Serial control is active
- isRunning:
    True when pump is running
- pumpModel:
    Display pump model and features (human readable)

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

###### PUMP_TURBO_5

Instance id: | SPB_IRD_VAC/TPUMP/PUMP_TURBO_5
Class id: | BeckhoffAdixenTurboFull
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAdixenTurboFull
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- standbyMode:
    When Standby Mode is selected, the pump speed will match the speed setpoint.
- nominalMode:
    When Nominal Mode is selected, the pump speed will match the nominally defined speed setpoint.
- off:
    Turn the pump off.
- on:
    Turn the pump on.
- pGroup:
    Remote has been configured via the device interface to allow remote commands when true.
- hardwareDeviceId:
    The Hardware Device ID. This value can range from 000 - 255, with a default value of 000
- isOn:
    True when pump is switched on
- isPurgeValveOpen:
    True when purge valve is open (e.g. while stopping).
- isVentValveOpen:
    True when vent valve is open
- isStandby:
    True when pump in in standby
- isWarning:
    True when pump has a warning active
- isOnTarget:
    True when pump is on target pressure
- isStarting:
    True when pump is starting
- isStopping:
    True when pump is stopping
- isStandbyMode:
    True when pump is in standby mode
- isSerialCtrl:
    True when Serial control is active
- isRunning:
    True when pump is running
- pumpModel:
    Display pump model and features (human readable)

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

###### PUMP_TURBO_6

Instance id: | SPB_IRD_VAC/TPUMP/PUMP_TURBO_6
Class id: | BeckhoffAdixenTurboFull
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAdixenTurboFull
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- standbyMode:
    When Standby Mode is selected, the pump speed will match the speed setpoint.
- nominalMode:
    When Nominal Mode is selected, the pump speed will match the nominally defined speed setpoint.
- off:
    Turn the pump off.
- on:
    Turn the pump on.
- pGroup:
    Remote has been configured via the device interface to allow remote commands when true.
- hardwareDeviceId:
    The Hardware Device ID. This value can range from 000 - 255, with a default value of 000
- isOn:
    True when pump is switched on
- isPurgeValveOpen:
    True when purge valve is open (e.g. while stopping).
- isVentValveOpen:
    True when vent valve is open
- isStandby:
    True when pump in in standby
- isWarning:
    True when pump has a warning active
- isOnTarget:
    True when pump is on target pressure
- isStarting:
    True when pump is starting
- isStopping:
    True when pump is stopping
- isStandbyMode:
    True when pump is in standby mode
- isSerialCtrl:
    True when Serial control is active
- isRunning:
    True when pump is running
- pumpModel:
    Display pump model and features (human readable)

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

###### PUMP_TURBO_7

Instance id: | SPB_IRD_VAC/TPUMP/PUMP_TURBO_7
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

###### PUMP_TURBO_8

Instance id: | SPB_IRD_VAC/TPUMP/PUMP_TURBO_8
Class id: | BeckhoffPfeifferTCDriveUnit
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffPfeifferTCDriveUnit
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-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.
- 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.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

##### TSENS

[add component documentation]

###### AI_3

Instance id: | SPB_IRD_VAC/TSENS/AI_3
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### AI_1

Instance id: | SPB_IRD_VAC/TSENS/AI_1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### AI_2

Instance id: | SPB_IRD_VAC/TSENS/AI_2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-08
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-08
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.4-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.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

#### GENERIC

[add component documentation]

##### PROC

[add component documentation]

###### SPECKLE_PROCESSOR

#### SACT

[add component documentation]

##### CTRL

[add component documentation]

###### MCS2

##### MOTOR

###### AXIS0

###### AXIS1

###### AXIS10

###### AXIS11

###### AXIS12

###### AXIS13

###### AXIS14

###### AXIS15

###### AXIS16

###### AXIS17

###### AXIS2

###### AXIS3

###### AXIS4

###### AXIS5

###### AXIS6

###### AXIS7

###### AXIS8

###### AXIS9

### IRU

[add component documentation]

#### VAC

[add component documentation]

##### VALVE

[add component documentation]

###### VALVE_VENT_3

Instance id: | SPB_IRU_VAC/VALVE/VALVE_VENT_3
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_INLINE_1

Instance id: | SPB_IRU_VAC/VALVE/VALVE_INLINE_1
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Scenes: | JetAlignment, Instrument-Overview-Long, Overview, EHU_ALAS_alignment, SPB_EHU_ALAS_alignment, DiamondValveOpen, Instrument-Overview-Long-NoCRL, SAXS-Instrument-Overview-NotUTD, Overview, Instrument-Overview-Long, EHU_ALAS_alignment, Overview, EHU_ALAS_alignment, EHU_ALAS_alignment, Instrument-Overview-Long, Overview, SPB-Mode-1-overview-RB, EHU_ALAS_alignment, SPB_EHU_ALAS_alignment, SPB Mode 1 overview, EHU_ALAS_alignment, EHU_ALAS_alignment, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, SPB_EHU_ALAS_alignment, EHU_ALAS_alignment, MPS_INTERLOCK, Overview, Valve_chk, EHU_ALAS_alignment, Valve_chk, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging, ElectroSpray, ElectroSpray_fm
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_INLINE_2

Instance id: | SPB_IRU_VAC/VALVE/VALVE_INLINE_2
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Scenes: | JetAlignment, IRU_VAC-GATEVALVE_DN500, Instrument-Overview-Long, AGIPD_Z_motion, inline2, agipd_overview, Instrument-Overview-Long-NoCRL, SAXS-Instrument-Overview-NotUTD, agipd_overview, Instrument-Overview-Long, IRU_VAC/VALVE/INLINE2, Instrument-Overview-Long, SPB-Mode-1-overview-RB, IRU_INJ_USER, SPB Mode 1 overview, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, SPB Mode S overview, agipd_overview, MPS_INTERLOCK, IRU_VAC/VALVE/INLINE2, Shift_End_Checks, Valve_chk, agipd_overview, agipd_compact_monitoring_overview, Valve_chk, Shift_End_Checks, Shift_End_Checks_HOME, Instrument-Overview-Long_CW39-42, agipd_overview, AGIPD_controls, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging, ElectroSpray, ElectroSpray_fm
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_INLINE_3

Instance id: | SPB_IRU_VAC/VALVE/VALVE_INLINE_3
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Scenes: | Instrument-Overview-Long, Instrument-Overview-Long-NoCRL, SAXS-Instrument-Overview-NotUTD, Instrument-Overview-Long, Instrument-Overview-Long, SPB-Mode-1-overview-RB, SPB Mode 1 overview, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, MPS_INTERLOCK, Overview, Valve_chk, Valve_chk, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_LOCK_1

Instance id: | SPB_IRU_VAC/VALVE/VALVE_LOCK_1
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Scenes: | JetAlignment, Instrument-Overview-Long, IRU_VAC-VALVE_InjectorLock, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging, ElectroSpray, ElectroSpray_fm
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_LOCK_2

Instance id: | SPB_IRU_VAC/VALVE/VALVE_LOCK_2
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_LOCK_3

Instance id: | SPB_IRU_VAC/VALVE/VALVE_LOCK_3
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_ROUGH_1

Instance id: | SPB_IRU_VAC/VALVE/VALVE_ROUGH_1
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Scenes: | Rough-Vacuum, Instrument-Overview-Long, Instrument-Overview-Long-NoCRL, SAXS-Instrument-Overview-NotUTD, Instrument-Overview-Long, Instrument-Overview-Long, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_ROUGH_2

Instance id: | SPB_IRU_VAC/VALVE/VALVE_ROUGH_2
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Scenes: | Rough-Vacuum, Instrument-Overview-Long, Instrument-Overview-Long-NoCRL, SAXS-Instrument-Overview-NotUTD, Instrument-Overview-Long, Instrument-Overview-Long, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_ROUGH_3

Instance id: | SPB_IRU_VAC/VALVE/VALVE_ROUGH_3
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_ROUGH_4

Instance id: | SPB_IRU_VAC/VALVE/VALVE_ROUGH_4
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_ROUGH_5

Instance id: | SPB_IRU_VAC/VALVE/VALVE_ROUGH_5
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Scenes: | Rough-Vacuum, Instrument-Overview-Long, Instrument-Overview-Long-NoCRL, SAXS-Instrument-Overview-NotUTD, Instrument-Overview-Long, Overview, Instrument-Overview-Long, Overview, IRU_INJ_USER, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, Overview, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_ROUGH_6

Instance id: | SPB_IRU_VAC/VALVE/VALVE_ROUGH_6
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_ROUGH_7

Instance id: | SPB_IRU_VAC/VALVE/VALVE_ROUGH_7
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_VENT_1

Instance id: | SPB_IRU_VAC/VALVE/VALVE_VENT_1
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Scenes: | Rough-Vacuum, Instrument-Overview-Long, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

###### VALVE_VENT_2

Instance id: | SPB_IRU_VAC/VALVE/VALVE_VENT_2
Class id: | BeckhoffValve
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffValve
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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.
- 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.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

##### DCTRL

[add component documentation]

###### VALVE_ROUGH_1_OPEN

Instance id: | SPB_IRU_VAC/DCTRL/VALVE_ROUGH_1_OPEN
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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

###### CAMERA_1030NM

Instance id: | SPB_IRU_VAC/DCTRL/CAMERA_1030NM
Host: | exflcon31n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T13:04:48.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Scenes: | IRU_LIC_CAM_1030NM, PPL_state_overview, IRU_LIC_PPL_state, IRU_LIC_CAM_1030NM, SPB_IRU_LIC_CAM_1030NM, SPB_IRU_LIC_CAM_1030NM, Lines_visualization
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### CAMERA_800NM

Instance id: | SPB_IRU_VAC/DCTRL/CAMERA_800NM
Host: | exflcon31n0
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
Git repo: | https://git.xfel.eu/gitlab/karaboDevices/Beckhoff
Last modified: | 2020-03-24T13:04:48.000+01:00
Created at: | 2017-07-20T11:58:15.000+02:00
Main authors: | Parenti, Giovanetti, Silenzi
Latest tag: | 4.3.11-2.7.0
Deployment tag: | 4.3.11-2.7.0
Installed tag: | 4.3.10-2.6.1
Scenes: | IRU_LIC_800NM, IRU_YAG_LASER, IRU_LIC_CAM_800NM, PPL_state_overview, IRU_LIC_PPL_state, IRU_LIC_CAM_800NM, IRU_YAG_CAM, IRU_YAG_illumination, SPB_IRU_LIC_CAM_800NM
Accessible by: | CONTROLS, DA, amunnich, jsztuk

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.3.10-2.6.1) does not match tags mentioned in the deployment ([‘4.3.11-2.7.0’])!

[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: |

###### CAMERA_TT

Instance id: | SPB_IRU_VAC/DCTRL/CAMERA_TT
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Scenes: | PPL_state_overview, IRU_LIC_PPL_state, IRU_LIC_CAM_TT, IRU_LIC_CAM_TT, IRU_LIC_CAM_pipe_in, PPL_CAMs
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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

###### GAUGE_FR_1

Instance id: | SPB_IRU_VAC/DCTRL/GAUGE_FR_1
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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

###### PUMP_TURBO_1_RPM80

Instance id: | SPB_IRU_VAC/DCTRL/PUMP_TURBO_1_RPM80
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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

###### PUMP_TURBO_2_RPM80

Instance id: | SPB_IRU_VAC/DCTRL/PUMP_TURBO_2_RPM80
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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

###### PUMP_TURBO_3_RPM80

Instance id: | SPB_IRU_VAC/DCTRL/PUMP_TURBO_3_RPM80
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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

###### VALVE_INLINE_2_CLOSE

Instance id: | SPB_IRU_VAC/DCTRL/VALVE_INLINE_2_CLOSE
Class id: | BeckhoffDigitalOutput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffDigitalOutput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Scenes: | SPB Mode M overview-RB0, SPB Mode S overview, MPS-MODE_M, MPS-MODE_M
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.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

##### GAUGE

[add component documentation]

###### GAUGE_PR_9

Instance id: | SPB_IRU_VAC/GAUGE/GAUGE_PR_9
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_1

Instance id: | SPB_IRU_VAC/GAUGE/GAUGE_FR_1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Scenes: | Instrument-Overview-Long, Overview, Pressure-Plots, Instrument-Overview-Long-NoCRL, VACUUM_FULL2, SAXS-Instrument-Overview-NotUTD, Overview, Instrument-Overview-Long, Overview, Instrument-Overview-Long, Overview, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, VACUUM_FULL2, Overview, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_2

Instance id: | SPB_IRU_VAC/GAUGE/GAUGE_FR_2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Scenes: | AerosolAlignment, JetAlignment, JetAlignment, Instrument-Overview-Long, Overview, SPB_IRU_SIDEMIC_USER, Pressure-Plots, AerosolAlignment, JetAlignment_newSideMicDriver, JetAlignment_Zyla, Instrument-Overview-Long-NoCRL, JetAlignment_Zyla, JetAlignment_Zyla, VACUUM_FULL2, Electrospray_Zyla0, SAXS-Instrument-Overview-NotUTD, Overview, JetAlignment, Instrument-Overview-Long, Overview, JetAlignment, Instrument-Overview-Long, Overview, IRU_INJ_USER, JetAlignment_newSideMicDriver, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, VACUUM_FULL2, Overview, HPLC_BIO, HPLC_BIO_MK, IRU_D12_Overview_Old, Instrument-Overview-Long_CW39-42, IRU_D12_Overview, IRU_D12_Overview_MK_Test, HPLC_BIO_MK_2, IRDa_D12_Overview, HPLC_TEST, HPLC_CBM40_test, IRU_SIDEMIC, IRU_D12_Overview_JB, IRU_D12_Overview_Old, IRU_D12_Overview_testMK0, IRU_D12_Overview, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging, ElectroSpray, Instrument_State_Overview, ElectroSpray_fm
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_3

Instance id: | SPB_IRU_VAC/GAUGE/GAUGE_FR_3
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Scenes: | AerosolAlignment, JetAlignment, JetAlignment, Instrument-Overview-Long, Overview, SPB_IRU_SIDEMIC_USER, Pressure-Plots, AerosolAlignment, JetAlignment_newSideMicDriver, JetAlignment_Zyla, Instrument-Overview-Long-NoCRL, JetAlignment_Zyla, JetAlignment_Zyla, VACUUM_FULL2, Electrospray_Zyla0, SAXS-Instrument-Overview-NotUTD, Overview, JetAlignment, Instrument-Overview-Long, Overview, JetAlignment, Instrument-Overview-Long, Overview, IRU_INJ_USER, JetAlignment_newSideMicDriver, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, VACUUM_FULL2, Overview, IRU_D12_Overview_Old, Instrument-Overview-Long_CW39-42, IRU_D12_Overview, IRDa_D12_Overview, IRU_SIDEMIC, IRU_D12_Overview_JB, IRU_D12_Overview_Old, IRU_D12_Overview_testMK0, IRU_D12_Overview, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging, ElectroSpray, ElectroSpray_fm
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_4

Instance id: | SPB_IRU_VAC/GAUGE/GAUGE_FR_4
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Scenes: | JetAlignment, Instrument-Overview-Long, Instrument-Overview-Long-NoCRL, Instrument-Overview-Long, Instrument-Overview-Long, IRU_INJ_USER, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, Instrument-Overview-Long_CW39-42, IRU_SIDEMIC, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging, ElectroSpray, ElectroSpray_fm
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_5

Instance id: | SPB_IRU_VAC/GAUGE/GAUGE_FR_5
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_FR_6

Instance id: | SPB_IRU_VAC/GAUGE/GAUGE_FR_6
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Scenes: | agipd_overview_old, AGIPD control - MFPGA, AGIPD vacuum test, Instrument-Overview-Long, DetPressure, agipd_overview, vacuum_tests, Cooling-Blocks-and-External-Housing-Temp, agipd_temp_vacuum_monitor, vacuum_tests_11.04, Instrument-Overview-Long-NoCRL, test, SAXS-Instrument-Overview-NotUTD, agipd_overview, Instrument-Overview-Long, DetPressure, Instrument-Overview-Long, Cooling Blocks and External Housing Temp. - jola tests at SPB, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, AGIPD control - Firmware tests, agipd_overview, test, DetPressure, Overview, agipd_overview, agipd_compact_monitoring_overview, Instrument-Overview-Long_CW39-42, agipd_overview, AGIPD_controls, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_PR_1

Instance id: | SPB_IRU_VAC/GAUGE/GAUGE_PR_1
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Scenes: | Rough-Vacuum, Instrument-Overview-Long, DetPressure, agipd_overview, vacuum_tests, Cooling-Blocks-and-External-Housing-Temp, agipd_temp_vacuum_monitor, vacuum_tests_11.04, Instrument-Overview-Long-NoCRL, SAXS-Instrument-Overview-NotUTD, agipd_overview, Instrument-Overview-Long, DetPressure, Instrument-Overview-Long, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, agipd_overview, DetPressure, Overview, agipd_overview, agipd_compact_monitoring_overview, Instrument-Overview-Long_CW39-42, agipd_overview, AGIPD_controls, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_PR_10

Instance id: | SPB_IRU_VAC/GAUGE/GAUGE_PR_10
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Scenes: | Instrument-Overview-Long, DetPressure, agipd_overview, vacuum_tests, Cooling-Blocks-and-External-Housing-Temp, agipd_temp_vacuum_monitor, vacuum_tests_11.04, Instrument-Overview-Long-NoCRL, SAXS-Instrument-Overview-NotUTD, agipd_overview, Instrument-Overview-Long, DetPressure, Instrument-Overview-Long, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, agipd_overview, DetPressure, Overview, agipd_overview, agipd_compact_monitoring_overview, Instrument-Overview-Long_CW39-42, agipd_overview, AGIPD_controls, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_PR_2

Instance id: | SPB_IRU_VAC/GAUGE/GAUGE_PR_2
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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

###### GAUGE_PR_3

Instance id: | SPB_IRU_VAC/GAUGE/GAUGE_PR_3
Class id: | BeckhoffAnalogInput
Host: | spb-rr-sys-con-05
Class documentation:
| BeckhoffAnalogInput
General: | link
Monitor: | link
Developer: | link
PLC: | link
Alias: | spb-rr-sys-con-05
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.4-2.11.1
Scenes: | AerosolAlignment, JetAlignment, JetAlignment, Instrument-Overview-Long, SPB_IRU_SIDEMIC_USER, Pressure-Plots, AerosolAlignment, JetAlignment_newSideMicDriver, JetAlignment_Zyla, Instrument-Overview-Long-NoCRL, JetAlignment_Zyla, JetAlignment_Zyla, Electrospray_Zyla0, SAXS-Instrument-Overview-NotUTD, JetAlignment, Instrument-Overview-Long, Overview, JetAlignment, Instrument-Overview-Long, Overview, IRU_INJ_USER, JetAlignment_newSideMicDriver, SAXS Instrument Overview, Instrument-Overview-NotUTD, Instrument-Overview-Long-IRDa, VACUUM_FULL2, Overview, Instrument-Overview-Long_CW39-42, Instrument-Overview-Long_SAXS, Instrument-Overview-Long_SAXS, Instrument-Overview-Long-Imaging, ElectroSpray, ElectroSpray_fm
Accessible by: | CAL, CONTROLS, CTRL, DA, DET, xdoc

Warning

Rogue installation which is not mentioned in the deployment!

Warning

The installed tag (4.6.4-2.11.1) does not match tags mentioned in the deployment ([‘4.6.4-2.11.1-peltier-hotfix-@SPB’])!

BeckhoffAnalogInput Documentation

The `BeckhoffAnalogInput` device is documented in beckhoff:BeckhoffAnalogInput

Device Schema Description

- visibility:
    Configures who is allowed to see this device at all
- deviceId:
    The device instance ID uniquely identifies a device instance in the distributed system
- classId:
    The (factory)-name of the class of this device
- classVersion:
    The version of the class of this device defined in KARABO_CLASSINFO
- karaboVersion:
    The version of the Karabo framework running this device
- serverId:
    The device-server on which this device is running on
- hostName:
    Do not set this property, it will be set by the device-server.
- pid:
    The unix process ID of the device (i.e. of the server
- state:
    The current state the device is in
- status:
    A more detailed status description
- alarmCondition:
    The current alarm condition of the device. Evaluates to the highest condition on any property if not set manually.
- lastCommand:
    The last slot called.
- archive:
    Decides whether the properties of this device will be logged or not
- heartbeatInterval:
    The heartbeat interval
- performanceStatistics:
    Accumulates some statistics
- beckhoffComDevice:
    InstanceId of the BeckhoffCom device that forwards commands to the PLC.
- functionBlockName:
    The type of the firmware block.
- fwInstanceName:
    The name of the firmware block instance.
- fwVersion:
    The version of the PLC framework.
- terminal:
    ???
- hardwareStatusBitField:
    This word encodes in bits the hardware-status information of this device
- hardwareState:
    The current state of the hardware decoded
- hardwareRegion:
    The current region of the hardware decoded
- hardwareErrorDescriptor:
    This word encodes in bits describing the hardware error
- hardwareErrorDescription:
    Error Code description
- waitingFor:
    Any call to the PLC will be published here, once the reply is received this property will be cleared. Commands will not be sent to the PLC until this property is cleared.
- epsilon:
    The epsilon determines the amount of change until a new physical value is posted from the hardware
- interlockReadOnly:
    Defines whether interlock conditions are configurable from this interface.
- interlockOn:
    Defines whether interlock surveillance is on or off.
- interlockOk:
    Defines whether interlock is ok (true) or broken (false).
- busy:
    Defines whether the PLC softdevice is busy.
- disableEpsilonFeedback:
    If false, the epsilon will be regulated until the incoming rate reaches the maximum rate
- maxStateUpdateRate:
    If state updates per second exceed this threshold, the state will be displayed as CHANGING
- noisyStateUpdateRateValue:
    Show the state update rate when it’s above ‘Max State Update Rate’ threshold.
- isStateUpdateNoisy:
    State update rate is above ‘Max State Update Rate’ threshold.
- reset:
    Resets the PLC hardware
- enableInterlockedSlots:
    Send device into INTERLOCK_BROKEN state, thus enabling all interlocked slots.
- disableInterlockedSlots:
    Send device into INTERLOCKED state, thus enabling all interlocked slots.
- requestHardwareValues:
    Ask for all property values on the device
- propertiesToPoll:
    All specified properties will be polled from the PLC with the given poll-rate. Only PLC aliases or device keys corresponding to PLC properties are allowed
- pollInterval:
    Hardware poll interval in seconds
- propertiesToRead:
    The specified properties will be read from the PLC by activating the Read button. Only PLC aliases or device keys corresponding to PLC properties are allowed
- readHardware:
    Requests value updates from the PLC for the properties listed under ‘Properties to read’
- force:
    ???
- trigger:
    Do not use this parameter to configure scheduled push. Instead use the parameter ‘scheduledPush’.
- maxUpdateFrequency:
    set to limit maximum update frequency for some values.
- value:
    Analog input of ADC.
- semiRawValue:
    Semi raw value of analog input, i.e. the voltage.
- epsSemiRaw:
    Epsilon of the SemiRawValue.
- relativeEpsilon:
    Flag to define epsilon mode: true means relative epsilon calculation, false means absolute epsilon calculation.

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